io.circe

ACursor

case class ACursor(either: Xor[HCursor, HCursor]) extends ACursorOperations with Product with Serializable

A cursor that tracks history and represents the possibility of failure.

See also

GenericCursor

Linear Supertypes
Serializable, Serializable, Product, Equals, ACursorOperations, GenericCursor[ACursor], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ACursor
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. ACursorOperations
  7. GenericCursor
  8. AnyRef
  9. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ACursor(either: Xor[HCursor, HCursor])

Type Members

  1. type Focus[x] = Option[x]

    The context that the cursor is available in.

    The context that the cursor is available in.

    Definition Classes
    ACursorOperations → GenericCursor
  2. type M[x[_]] = Applicative[x]

    The type class including the operations needed for withFocusM.

    The type class including the operations needed for withFocusM.

    Definition Classes
    ACursorOperations → GenericCursor
  3. type Result = ACursor

    The type returned by navigation and modifications operations.

    The type returned by navigation and modifications operations.

    Definition Classes
    ACursorOperations → GenericCursor

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

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

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. def any: HCursor

    Return the underlying cursor.

  7. def as[A](implicit d: Decoder[A]): Xor[DecodingFailure, A]

    Attempt to decode the focus as an A.

    Attempt to decode the focus as an A.

    Definition Classes
    ACursorOperations → GenericCursor
  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def cursor: Option[Cursor]

    Return the underlying cursor if successful.

  11. def delete: ACursor

    Delete the focus and move to its parent.

    Delete the focus and move to its parent.

    Definition Classes
    ACursorOperations → GenericCursor
  12. def deleteGoField(k: String): ACursor

    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
    ACursorOperations → GenericCursor
  13. def deleteGoFirst: ACursor

    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
    ACursorOperations → GenericCursor
  14. def deleteGoLast: ACursor

    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
    ACursorOperations → GenericCursor
  15. def deleteGoLeft: ACursor

    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
    ACursorOperations → GenericCursor
  16. def deleteGoRight: ACursor

    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
    ACursorOperations → GenericCursor
  17. def deleteLefts: ACursor

    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
    ACursorOperations → GenericCursor
  18. def deleteRights: ACursor

    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
    ACursorOperations → GenericCursor
  19. 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
    ACursorOperations → GenericCursor
  20. def downAt(p: (Json) ⇒ Boolean): ACursor

    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
    ACursorOperations → GenericCursor
  21. 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
    ACursorOperations → GenericCursor
  22. 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
    ACursorOperations → GenericCursor
  23. val either: Xor[HCursor, HCursor]

  24. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  25. def failed: Boolean

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

  26. def failure: Option[HCursor]

    Return the failed HCursor if we are in a failure state.

  27. def failureFocus: Option[Json]

    Return the previous focus, if and only if we didn't succeed.

  28. 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
    ACursorOperations → GenericCursor
  29. def fieldSet: Option[Set[String]]

    If the focus is a JSON object, return its field names in a set.

    If the focus is a JSON object, return its field names in a set.

    Definition Classes
    ACursorOperations → GenericCursor
  30. def fields: Option[List[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
    ACursorOperations → GenericCursor
  31. def finalize(): Unit

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

    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
    ACursorOperations → GenericCursor
  33. def first: ACursor

    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
    ACursorOperations → GenericCursor
  34. def focus: Option[Json]

    The current location in the document.

    The current location in the document.

    Definition Classes
    ACursorOperations → GenericCursor
  35. def get[A](k: String)(implicit d: Decoder[A]): Xor[DecodingFailure, 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
    ACursorOperations → GenericCursor
  36. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  37. def history: List[CursorOp]

    Return the underlying cursor's history.

  38. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  39. def last: ACursor

    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
    ACursorOperations → GenericCursor
  40. 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
    ACursorOperations → GenericCursor
  41. def leftAt(p: (Json) ⇒ Boolean): ACursor

    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
    ACursorOperations → GenericCursor
  42. def leftN(n: Int): ACursor

    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
    ACursorOperations → GenericCursor
  43. def lefts: Option[List[Json]]

    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
    ACursorOperations → GenericCursor
  44. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  45. final def notify(): Unit

    Definition Classes
    AnyRef
  46. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  47. def reattempt: ACursor

    If the last operation was not successful, reattempt it.

  48. 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
    ACursorOperations → GenericCursor
  49. def rightAt(p: (Json) ⇒ Boolean): ACursor

    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
    ACursorOperations → GenericCursor
  50. def rightN(n: Int): ACursor

    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
    ACursorOperations → GenericCursor
  51. def rights: Option[List[Json]]

    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
    ACursorOperations → GenericCursor
  52. def set(j: Json): ACursor

    Replace the focus.

    Replace the focus.

    Definition Classes
    GenericCursor
  53. def setLefts(x: List[Json]): ACursor

    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
    ACursorOperations → GenericCursor
  54. def setRights(x: List[Json]): ACursor

    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
    ACursorOperations → GenericCursor
  55. def succeeded: Boolean

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

  56. def success: Option[HCursor]

    Return the current HCursor if we are in a success state.

  57. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  58. def top: Option[Json]

    Return to the root of the document.

    Return to the root of the document.

    Definition Classes
    ACursorOperations → GenericCursor
  59. def up: ACursor

    Move the focus to the parent.

    Move the focus to the parent.

    Definition Classes
    ACursorOperations → GenericCursor
  60. def validation: Validated[HCursor, HCursor]

    Return a cats.data.Validated of the underlying cursor.

  61. final def wait(): Unit

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

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

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

    Modify the focus using the given function.

    Modify the focus using the given function.

    Definition Classes
    ACursorOperations → GenericCursor
  65. 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
    ACursorOperations → GenericCursor
  66. def |||(c: ⇒ ACursor): ACursor

    Return the current cursor or the given one if this one isn't successful.

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from ACursorOperations

Inherited from GenericCursor[ACursor]

Inherited from AnyRef

Inherited from Any

Type members

ACursor fields and operations

Access and navigation

Modification

Array access

Object access

Array navigation

Object navigation

Array modification

Object modification

Decoding