Relative

io.circe.pointer.Pointer.Relative
See theRelative companion object
sealed abstract class Relative extends Pointer

Represents a relative JSON Pointer.

Attributes

Companion
object
Source
Pointer.scala
Graph
Supertypes
class Pointer
trait ACursor => ACursor
class Object
trait Matchable
class Any

Members list

Value members

Abstract methods

def distance: Int

Attributes

Source
Pointer.scala

Attributes

Source
Pointer.scala

Attributes

Source
Pointer.scala

Concrete methods

final def asAbsolute: Option[Absolute]

Return this pointer as a Pointer.Absolute if possible.

Return this pointer as a Pointer.Absolute if possible.

Attributes

Source
Pointer.scala
final def asRelative: Option[Relative]

Return this pointer as a Pointer.Relative if possible.

Return this pointer as a Pointer.Relative if possible.

Attributes

Source
Pointer.scala

Inherited methods

def andThen[A](g: ACursor => A): ACursor => A

Attributes

Inherited from:
Function1
def compose[A](g: A => ACursor): A => ACursor

Attributes

Inherited from:
Function1
final def get(input: Json): Either[PointerFailure, Json]

Attempt to get the value at the location pointed to, returning the history if it doesn't exist.

Attempt to get the value at the location pointed to, returning the history if it doesn't exist.

Attributes

Inherited from:
Pointer
Source
Pointer.scala
override def toString(): String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Function1 -> Any
Inherited from:
Function1

Inherited and Abstract methods

Attributes

Inherited from:
Function1
def getOption(input: Json): Option[Json]

Attempt to get the value at the location pointed to.

Attempt to get the value at the location pointed to.

Attributes

Note

For absolute pointers this method may be faster than get or apply, since it does not have to track error locations.

Inherited from:
Pointer
Source
Pointer.scala