Packages

c

io.circe

FailedCursor

final class FailedCursor extends ACursor

Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. FailedCursor
  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 FailedCursor(lastCursor: HCursor, lastOp: CursorOp)

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 FailedCursor toany2stringadd[FailedCursor] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (FailedCursor, B)
    Implicit
    This member is added by an implicit conversion from FailedCursor toArrowAssoc[FailedCursor] 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. def delete: ACursor

    Delete the focus and move to its parent.

    Delete the focus and move to its parent.

    Definition Classes
    FailedCursorACursor
  10. 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
    FailedCursorACursor
  11. 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
    FailedCursorACursor
  12. 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
    FailedCursorACursor
  13. def ensuring(cond: (FailedCursor) => Boolean, msg: => Any): FailedCursor
    Implicit
    This member is added by an implicit conversion from FailedCursor toEnsuring[FailedCursor] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: (FailedCursor) => Boolean): FailedCursor
    Implicit
    This member is added by an implicit conversion from FailedCursor toEnsuring[FailedCursor] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean, msg: => Any): FailedCursor
    Implicit
    This member is added by an implicit conversion from FailedCursor toEnsuring[FailedCursor] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: Boolean): FailedCursor
    Implicit
    This member is added by an implicit conversion from FailedCursor toEnsuring[FailedCursor] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  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 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
    FailedCursorACursor
  21. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  22. def focus: Option[Json]

    The current location in the document.

    The current location in the document.

    Definition Classes
    FailedCursorACursor
  23. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from FailedCursor toStringFormat[FailedCursor] 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 incorrectFocus: Boolean

    Indicates whether the last operation failed because the type of the focus was wrong.

  30. 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
    FailedCursorACursor
  31. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  32. 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
    FailedCursorACursor
  33. 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
    FailedCursorACursor
  34. def last: ACursor
  35. 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
    FailedCursorACursor
  36. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  37. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  38. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  39. 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
  40. final def replayOne(op: CursorOp): ACursor

    Replay an operation against this cursor.

    Replay an operation against this cursor.

    Definition Classes
    ACursor
  41. 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
    FailedCursorACursor
  42. def root: HCursor

    Return the cursor to the root of the document.

    Return the cursor to the root of the document.

    Definition Classes
    FailedCursorACursor
  43. final def set(j: Json): ACursor

    Replace the focus.

    Replace the focus.

    Definition Classes
    ACursor
  44. 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
    FailedCursorACursor
  45. 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
    FailedCursorACursor
  46. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  47. def toString(): String
    Definition Classes
    AnyRef → Any
  48. def top: Option[Json]

    Return to the root of the document.

    Return to the root of the document.

    Definition Classes
    FailedCursorACursor
  49. def up: ACursor

    Move the focus to the parent.

    Move the focus to the parent.

    Definition Classes
    FailedCursorACursor
  50. 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
    FailedCursorACursor
  51. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  52. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  53. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  54. def withFocus(f: (Json) => Json): ACursor

    Modify the focus using the given function.

    Modify the focus using the given function.

    Definition Classes
    FailedCursorACursor
  55. 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
    FailedCursorACursor

Deprecated Value Members

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

Inherited by implicit conversion StringFormat fromFailedCursor to StringFormat[FailedCursor]

Inherited by implicit conversion Ensuring fromFailedCursor to Ensuring[FailedCursor]

Inherited by implicit conversion ArrowAssoc fromFailedCursor to ArrowAssoc[FailedCursor]

Miscellaneous utilities

Access and navigation

Modification

Array access

Object access

Array navigation

Object navigation

Decoding

Ungrouped