Packages

abstract class HCursor extends ACursor

Source
HCursor.scala
Linear Supertypes
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. HCursor
  2. ACursor
  3. Serializable
  4. AnyRef
  5. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new HCursor(lastCursor: HCursor, lastOp: CursorOp)

Abstract Value Members

  1. abstract def addOp(cursor: HCursor, op: CursorOp): HCursor
  2. abstract def delete: ACursor

    Delete the focus and move to its parent.

    Delete the focus and move to its parent.

    Definition Classes
    ACursor
  3. abstract 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.

    Definition Classes
    ACursor
  4. abstract 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.

    Definition Classes
    ACursor
  5. abstract def replace(newValue: Json, cursor: HCursor, op: CursorOp): HCursor
  6. abstract 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.

    Definition Classes
    ACursor
  7. abstract def up: ACursor

    Move the focus to the parent.

    Move the focus to the parent.

    Definition Classes
    ACursor
  8. abstract def value: Json

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from HCursor toany2stringadd[HCursor] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (HCursor, B)
    Implicit
    This member is added by an implicit conversion from HCursor toArrowAssoc[HCursor] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. 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.

    Definition Classes
    ACursor
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  9. final 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.

    Definition Classes
    HCursorACursor
  10. final 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.

    Definition Classes
    HCursorACursor
  11. final 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.

    Definition Classes
    HCursorACursor
  12. def ensuring(cond: (HCursor) => Boolean, msg: => Any): HCursor
    Implicit
    This member is added by an implicit conversion from HCursor toEnsuring[HCursor] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: (HCursor) => Boolean): HCursor
    Implicit
    This member is added by an implicit conversion from HCursor toEnsuring[HCursor] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean, msg: => Any): HCursor
    Implicit
    This member is added by an implicit conversion from HCursor toEnsuring[HCursor] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean): HCursor
    Implicit
    This member is added by an implicit conversion from HCursor toEnsuring[HCursor] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  18. final def fail(op: CursorOp): ACursor

    Create a new cursor that has failed on the given operation.

    Create a new cursor that has failed on the given operation.

    Attributes
    protected[this]
  19. 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.

    Definition Classes
    ACursor
  20. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  21. final def find(p: (Json) => Boolean): ACursor
  22. final def focus: Option[Json]

    The current location in the document.

    The current location in the document.

    Definition Classes
    HCursorACursor
  23. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from HCursor toStringFormat[HCursor] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  24. 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.

    Definition Classes
    ACursor
  25. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  26. 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 field k is missing, then use the fallback instead.

    Definition Classes
    ACursor
  27. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  28. final def history: List[CursorOp]

    The operations that have been performed so far.

    The operations that have been performed so far.

    Definition Classes
    ACursor
  29. def index: Option[Int]

    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.

    Definition Classes
    ACursor
  30. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  31. 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.

    Definition Classes
    ACursor
  32. final 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.

    Definition Classes
    HCursorACursor
  33. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  34. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  35. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  36. 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.

    Definition Classes
    ACursor
  37. final def replayOne(op: CursorOp): ACursor

    Replay an operation against this cursor.

    Replay an operation against this cursor.

    Definition Classes
    ACursor
  38. final def root: HCursor

    Return the cursor to the root of the document.

    Return the cursor to the root of the document.

    Definition Classes
    HCursorACursor
  39. final def set(j: Json): ACursor

    Replace the focus.

    Replace the focus.

    Definition Classes
    ACursor
  40. final 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.

    Definition Classes
    HCursorACursor
  41. final def success: Option[HCursor]

    Return the cursor as an HCursor if it was successful.

    Return the cursor as an HCursor if it was successful.

    Definition Classes
    HCursorACursor
  42. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  43. def toString(): String
    Definition Classes
    AnyRef → Any
  44. final def top: Option[Json]

    Return to the root of the document.

    Return to the root of the document.

    Definition Classes
    HCursorACursor
  45. final 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.

    Definition Classes
    HCursorACursor
  46. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  47. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  48. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  49. final def withFocus(f: (Json) => Json): ACursor

    Modify the focus using the given function.

    Modify the focus using the given function.

    Definition Classes
    HCursorACursor
  50. final 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.

    Definition Classes
    HCursorACursor

Deprecated Value Members

  1. def [B](y: B): (HCursor, B)
    Implicit
    This member is added by an implicit conversion from HCursor toArrowAssoc[HCursor] 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.

Inherited from ACursor

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromHCursor to any2stringadd[HCursor]

Inherited by implicit conversion StringFormat fromHCursor to StringFormat[HCursor]

Inherited by implicit conversion Ensuring fromHCursor to Ensuring[HCursor]

Inherited by implicit conversion ArrowAssoc fromHCursor to ArrowAssoc[HCursor]

Miscellaneous utilities

Access and navigation

Modification

Array access

Object access

Array navigation

Object navigation

Decoding

Ungrouped