Circe core/io.circe/HCursor

HCursor

abstract class HCursor(lastCursor: HCursor, lastOp: CursorOp) extends ACursor
Companion:
object
Source:
HCursor.scala
class ACursor
trait Serializable
class Object
trait Matchable
class Any

Value members

Abstract methods

def addOp(cursor: HCursor, op: CursorOp): HCursor
def replace(newValue: Json, cursor: HCursor, op: CursorOp): HCursor

Concrete methods

final def downField(k: String): ACursor
final def downN(n: Int): ACursor
final def find(p: Json => Boolean): ACursor
final def focus: Option[Json]
final override def root: HCursor
Definition Classes
Source:
HCursor.scala
final def top: Option[Json]
final def withFocus(f: Json => Json): ACursor
final def withFocusM[F[_]](f: Json => F[Json])(implicit F: Applicative[F]): F[ACursor]

Inherited methods

final def as[A](implicit d: Decoder[A]): Result[A]

Attempt to decode the focus as an A.

Attempt to decode the focus as an A.

Inherited from:
ACursor
Source:
ACursor.scala
def delete: ACursor

Delete the focus and move to its parent.

Delete the focus and move to its parent.

Inherited from:
ACursor
Source:
ACursor.scala
final def failed: Boolean

Indicate whether this cursor represents the result of an unsuccessful operation.

Indicate whether this cursor represents the result of an unsuccessful operation.

Inherited from:
ACursor
Source:
ACursor.scala
def field(k: String): ACursor

If the focus is a value in a JSON object, move to a sibling with the given key.

If the focus is a value in a JSON object, move to a sibling with the given key.

Inherited from:
ACursor
Source:
ACursor.scala
final def get[A](k: String)(implicit d: Decoder[A]): Result[A]

Attempt to decode the value at the given key in a JSON object as an A.

Attempt to decode the value at the given key in a JSON object as an A.

Inherited from:
ACursor
Source:
ACursor.scala
final def getOrElse[A](k: String)(fallback: => A)(implicit d: Decoder[A]): Result[A]

Attempt to decode the value at the given key in a JSON object as an A. If the field k is missing, then use the fallback instead.

Attempt to decode the value at the given key in a JSON object as an A. If the field k is missing, then use the fallback instead.

Inherited from:
ACursor
Source:
ACursor.scala
final def history: List[CursorOp]

The operations that have been performed so far.

The operations that have been performed so far.

Inherited from:
ACursor
Source:
ACursor.scala
def index: Option[Int]

If the focus is a value in a JSON array, return the key.

If the focus is a value in a JSON array, return the key.

Inherited from:
ACursor
Source:
ACursor.scala
def key: Option[String]

If the focus is a value in a JSON object, return the key.

If the focus is a value in a JSON object, return the key.

Inherited from:
ACursor
Source:
ACursor.scala
def left: ACursor

If the focus is an element in a JSON array, move to the left.

If the focus is an element in a JSON array, move to the left.

Inherited from:
ACursor
Source:
ACursor.scala
final def pathString: String

Creates a JavaScript-style path string, e.g. ".foo.bar[3]".

Creates a JavaScript-style path string, e.g. ".foo.bar[3]".

Inherited from:
ACursor
Source:
ACursor.scala
final def replay(history: List[CursorOp]): ACursor

Replay history (a list of operations in reverse "chronological" order) against this cursor.

Replay history (a list of operations in reverse "chronological" order) against this cursor.

Inherited from:
ACursor
Source:
ACursor.scala
final def replayOne(op: CursorOp): ACursor

Replay an operation against this cursor.

Replay an operation against this cursor.

Inherited from:
ACursor
Source:
ACursor.scala
def right: ACursor

If the focus is an element in a JSON array, move to the right.

If the focus is an element in a JSON array, move to the right.

Inherited from:
ACursor
Source:
ACursor.scala
final def set(j: Json): ACursor

Replace the focus.

Replace the focus.

Inherited from:
ACursor
Source:
ACursor.scala
def up: ACursor

Move the focus to the parent.

Move the focus to the parent.

Inherited from:
ACursor
Source:
ACursor.scala