Circe core/io.circe/ACursor

ACursor

abstract class ACursor(lastCursor: HCursor, lastOp: CursorOp) extends Serializable

A zipper that represents a position in a JSON document and supports navigation and modification.

The focus represents the current position of the cursor; it may be updated with withFocus or changed using navigation methods like left and right.

Companion:
object
Source:
ACursor.scala
trait Serializable
class Object
trait Matchable
class Any
class HCursor

Value members

Abstract methods

def delete: ACursor

Delete the focus and move to its parent.

Delete the focus and move to its parent.

Source:
ACursor.scala
def downArray: ACursor

If the focus is a JSON array, move to its first element.

If the focus is a JSON array, move to its first element.

Source:
ACursor.scala
def downField(k: String): ACursor

If the focus is a JSON object, move to the value of the given key.

If the focus is a JSON object, move to the value of the given key.

Source:
ACursor.scala
def downN(n: Int): ACursor

If the focus is a JSON array, move to the element at the given index.

If the focus is a JSON array, move to the element at the given index.

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.

Source:
ACursor.scala
def focus: Option[Json]

The current location in the document.

The current location in the document.

Source:
ACursor.scala
def keys: Option[Iterable[String]]

If the focus is a JSON object, return its field names in their original order.

If the focus is a JSON object, return its field names in their original order.

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.

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.

Source:
ACursor.scala
def succeeded: Boolean

Indicate whether this cursor represents the result of a successful operation.

Indicate whether this cursor represents the result of a successful operation.

Source:
ACursor.scala
def success: Option[HCursor]

Return the cursor as an HCursor if it was successful.

Return the cursor as an HCursor if it was successful.

Source:
ACursor.scala
def top: Option[Json]

Return to the root of the document.

Return to the root of the document.

Source:
ACursor.scala
def up: ACursor

Move the focus to the parent.

Move the focus to the parent.

Source:
ACursor.scala
def values: Option[Iterable[Json]]

If the focus is a JSON array, return its elements.

If the focus is a JSON array, return its elements.

Source:
ACursor.scala
def withFocus(f: Json => Json): ACursor

Modify the focus using the given function.

Modify the focus using the given function.

Source:
ACursor.scala
def withFocusM[F[_]](f: Json => F[Json])(implicit F: Applicative[F]): F[ACursor]

Modify the focus in a context using the given function.

Modify the focus in a context using the given function.

Source:
ACursor.scala

Concrete 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.

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.

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.

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.

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

The operations that have been performed so far.

The operations that have been performed so far.

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.

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.

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]".

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.

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

Replay an operation against this cursor.

Replay an operation against this cursor.

Source:
ACursor.scala
def root: HCursor

Return the cursor to the root of the document.

Return the cursor to the root of the document.

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

Replace the focus.

Replace the focus.

Source:
ACursor.scala