Class/Object

io.circe

HCursor

Related Docs: object HCursor | package circe

Permalink

abstract class HCursor extends ACursor

Linear Supertypes
ACursor, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HCursor
  2. ACursor
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

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

    Permalink

Abstract Value Members

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

    Permalink
  2. abstract def delete: ACursor

    Permalink

    Delete the focus and move to its parent.

    Delete the focus and move to its parent.

    Definition Classes
    ACursor
  3. abstract def deleteGoField(k: String): ACursor

    Permalink

    Delete the focus and move to the sibling with the given key in a JSON object.

    Delete the focus and move to the sibling with the given key in a JSON object.

    Definition Classes
    ACursor
  4. abstract def deleteGoFirst: ACursor

    Permalink

    Delete the focus and move to the first element in a JSON array.

    Delete the focus and move to the first element in a JSON array.

    Definition Classes
    ACursor
  5. abstract def deleteGoLast: ACursor

    Permalink

    Delete the focus and move to the last element in a JSON array.

    Delete the focus and move to the last element in a JSON array.

    Definition Classes
    ACursor
  6. abstract def deleteGoLeft: ACursor

    Permalink

    Delete the focus and move to the left in a JSON array.

    Delete the focus and move to the left in a JSON array.

    Definition Classes
    ACursor
  7. abstract def deleteGoRight: ACursor

    Permalink

    Delete the focus and move to the right in a JSON array.

    Delete the focus and move to the right in a JSON array.

    Definition Classes
    ACursor
  8. abstract def deleteLefts: ACursor

    Permalink

    Delete all values to the left of the focus in a JSON array.

    Delete all values to the left of the focus in a JSON array.

    Definition Classes
    ACursor
  9. abstract def deleteRights: ACursor

    Permalink

    Delete all values to the right of the focus in a JSON array.

    Delete all values to the right of the focus in a JSON array.

    Definition Classes
    ACursor
  10. abstract def field(k: String): ACursor

    Permalink

    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
  11. abstract def first: ACursor

    Permalink

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

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

    Definition Classes
    ACursor
  12. abstract def last: ACursor

    Permalink

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

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

    Definition Classes
    ACursor
  13. abstract def left: ACursor

    Permalink

    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
  14. abstract def lefts: Option[Vector[Json]]

    Permalink

    If the focus is a JSON array, return the elements to the left.

    If the focus is a JSON array, return the elements to the left.

    Definition Classes
    ACursor
  15. abstract def replace(newValue: Json, cursor: HCursor, op: CursorOp): HCursor

    Permalink
  16. abstract def right: ACursor

    Permalink

    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
  17. abstract def rights: Option[Vector[Json]]

    Permalink

    If the focus is a JSON array, return the elements to the right.

    If the focus is a JSON array, return the elements to the right.

    Definition Classes
    ACursor
  18. abstract def setLefts(x: Vector[Json]): ACursor

    Permalink

    Replace all values to the left of the focus in a JSON array.

    Replace all values to the left of the focus in a JSON array.

    Definition Classes
    ACursor
  19. abstract def setRights(x: Vector[Json]): ACursor

    Permalink

    Replace all values to the right of the focus in a JSON array.

    Replace all values to the right of the focus in a JSON array.

    Definition Classes
    ACursor
  20. abstract def up: ACursor

    Permalink

    Move the focus to the parent.

    Move the focus to the parent.

    Definition Classes
    ACursor
  21. abstract def value: Json

    Permalink

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def as[A](implicit d: Decoder[A]): Result[A]

    Permalink

    Attempt to decode the focus as an A.

    Attempt to decode the focus as an A.

    Definition Classes
    ACursor
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. final def downArray: ACursor

    Permalink

    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
  8. final def downAt(p: (Json) ⇒ Boolean): ACursor

    Permalink

    If the focus is a JSON array, move to the first element that satisfies the given predicate.

    If the focus is a JSON array, move to the first element that satisfies the given predicate.

    Definition Classes
    HCursorACursor
  9. final def downField(k: String): ACursor

    Permalink

    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
  10. final def downN(n: Int): ACursor

    Permalink

    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
  11. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  12. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  13. final def fail(op: CursorOp): ACursor

    Permalink

    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]
  14. final def failed: Boolean

    Permalink

    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
  15. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. final def find(p: (Json) ⇒ Boolean): ACursor

    Permalink

    If the focus is an element in a JSON array, find the first element at or to its right that matches the given predicate.

    If the focus is an element in a JSON array, find the first element at or to its right that matches the given predicate.

    Definition Classes
    HCursorACursor
  17. final def focus: Option[Json]

    Permalink

    The current location in the document.

    The current location in the document.

    Definition Classes
    HCursorACursor
  18. final def get[A](k: String)(implicit d: Decoder[A]): Result[A]

    Permalink

    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
  19. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  20. final def getOrElse[A](k: String)(fallback: ⇒ A)(implicit d: Decoder[A]): Result[A]

    Permalink

    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
  21. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  22. final def history: List[CursorOp]

    Permalink

    The operations that have been performed so far.

    The operations that have been performed so far.

    Definition Classes
    ACursor
  23. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  24. final def keys: Option[Iterable[String]]

    Permalink

    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
  25. final def leftAt(p: (Json) ⇒ Boolean): ACursor

    Permalink

    If the focus is an element in a JSON array, move to the left until the given predicate matches the new focus.

    If the focus is an element in a JSON array, move to the left until the given predicate matches the new focus.

    Definition Classes
    HCursorACursor
  26. final def leftN(n: Int): ACursor

    Permalink

    If the focus is an element in JSON array, move to the left the given number of times.

    If the focus is an element in JSON array, move to the left the given number of times.

    A negative value will move the cursor right.

    Definition Classes
    HCursorACursor
  27. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  28. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  29. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  30. final def replay(history: List[CursorOp]): ACursor

    Permalink

    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
  31. final def replayOne(op: CursorOp): ACursor

    Permalink

    Replay an operation against this cursor.

    Replay an operation against this cursor.

    Definition Classes
    ACursor
  32. final def rightAt(p: (Json) ⇒ Boolean): ACursor

    Permalink

    If the focus is an element in a JSON array, move to the right until the given predicate matches the new focus.

    If the focus is an element in a JSON array, move to the right until the given predicate matches the new focus.

    Definition Classes
    HCursorACursor
  33. final def rightN(n: Int): ACursor

    Permalink

    If the focus is an element in JSON array, move to the right the given number of times.

    If the focus is an element in JSON array, move to the right the given number of times.

    A negative value will move the cursor left.

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

    Permalink

    Replace the focus.

    Replace the focus.

    Definition Classes
    ACursor
  35. final def succeeded: Boolean

    Permalink

    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
  36. final def success: Option[HCursor]

    Permalink

    Return the cursor as an HCursor if it was successful.

    Return the cursor as an HCursor if it was successful.

    Definition Classes
    HCursorACursor
  37. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  38. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  39. final def top: Option[Json]

    Permalink

    Return to the root of the document.

    Return to the root of the document.

    Definition Classes
    HCursorACursor
  40. final def values: Option[Iterable[Json]]

    Permalink

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

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

    Definition Classes
    HCursorACursor
  41. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  42. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  43. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  44. final def withFocus(f: (Json) ⇒ Json): ACursor

    Permalink

    Modify the focus using the given function.

    Modify the focus using the given function.

    Definition Classes
    HCursorACursor
  45. final def withFocusM[F[_]](f: (Json) ⇒ F[Json])(implicit F: Applicative[F]): F[ACursor]

    Permalink

    Modify the focus in a context using the given function.

    Modify the focus in a context using the given function.

    Definition Classes
    HCursorACursor

Inherited from ACursor

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Miscellaneous utilities

Access and navigation

Modification

Array access

Object access

Array navigation

Object navigation

Array modification

Object modification

Decoding

Ungrouped