abstract class ACursor 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.
- Source
- ACursor.scala
- Grouped
- Alphabetic
- By Inheritance
- ACursor
- Serializable
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def delete: ACursor
Delete the focus and move to its parent.
- abstract def downArray: ACursor
If the focus is a JSON array, move to its first element.
- abstract def downField(k: String): ACursor
If the focus is a JSON object, move to the value of the given key.
- abstract def downN(n: Int): ACursor
If the focus is a JSON array, move to the element at the given index.
- abstract def field(k: String): ACursor
If the focus is a value in a JSON object, move to a sibling with the given key.
- abstract def focus: Option[Json]
The current location in the document.
- abstract def keys: Option[Iterable[String]]
If the focus is a JSON object, return its field names in their original order.
- abstract def left: ACursor
If the focus is an element in a JSON array, move to the left.
- abstract def right: ACursor
If the focus is an element in a JSON array, move to the right.
- abstract def succeeded: Boolean
Indicate whether this cursor represents the result of a successful operation.
- abstract def success: Option[HCursor]
Return the cursor as an HCursor if it was successful.
- abstract def top: Option[Json]
Return to the root of the document.
- abstract def up: ACursor
Move the focus to the parent.
- abstract def values: Option[Iterable[Json]]
If the focus is a JSON array, return its elements.
- abstract def withFocus(f: (Json) => Json): ACursor
Modify the focus using the given function.
- abstract def withFocusM[F[_]](f: (Json) => F[Json])(implicit F: Applicative[F]): F[ACursor]
Modify the focus in a context using the given function.
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (ACursor, B)
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def as[A](implicit d: Decoder[A]): Result[A]
Attempt to decode the focus as an
A. - final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def ensuring(cond: (ACursor) => Boolean, msg: => Any): ACursor
- def ensuring(cond: (ACursor) => Boolean): ACursor
- def ensuring(cond: Boolean, msg: => Any): ACursor
- def ensuring(cond: Boolean): ACursor
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def failed: Boolean
Indicate whether this cursor represents the result of an unsuccessful operation.
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def formatted(fmtstr: String): String
- 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. - final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- 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.Attempt to decode the value at the given key in a JSON object as an
A. If the fieldkis missing, then use thefallbackinstead. - def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def history: List[CursorOp]
The operations that have been performed so far.
- def index: Option[Int]
If the focus is a value in a JSON object, return the key.
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def key: Option[String]
If the focus is a value in a JSON object, return the key.
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def replay(history: List[CursorOp]): ACursor
Replay history (a list of operations in reverse "chronological" order) against this cursor.
- final def replayOne(op: CursorOp): ACursor
Replay an operation against this cursor.
- def root: HCursor
Return the cursor to the root of the document.
- final def set(j: Json): ACursor
Replace the focus.
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
Deprecated Value Members
- def →[B](y: B): (ACursor, B)
- Implicit
- This member is added by an implicit conversion from ACursor toArrowAssoc[ACursor] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.