Packages

  • package root
    Definition Classes
    root
  • package io
    Definition Classes
    root
  • package circe

    This is the API documentation for Circe, a JSON library for Scala and Scala.js.

    Overview

    This is the API documentation for Circe, a JSON library for Scala and Scala.js.

    The library is divided into a number of modules that either provide core functionality, support additional features via third-party dependencies, or facilitate integration with other libraries or frameworks.

    • numbers: core facilities for representing and parsing JSON numbers.
    • core: our JSON abstract syntax tree, our zipper-like cursor types, and our encoding and decoding type classes (and instances).
    • parser: JSON parsing support for both the Java Virtual Machine (using Jawn) and Scala.js (using the native JavaScript JSON parser).
    • testing: ScalaCheck Arbitrary instances for circe's JSON AST and other types, as well as other useful testing tools.
    • literal: JSON string interpolation and encoder and decoder instances for literal types.
    • generic: Shapeless-powered generic derivation for case classes and sealed trait hierarchies.
    • generic-extras: additional experimental generic derivation functionality (including some configurability).
    • pointer: A JSON Pointer implementation
    • pointer-literal: JSON Pointer string interpolation
    • shapes: encoders and decoders for Shapeless hlists, coproducts, records, and sized collections.
    • scodec: encoders and decoders for Scodec's BitVector and ByteVector.
    • refined: encoders and decoders for refined types.
    • spray: Spray marshaller conversions for Circe's type classes.

    Please refer to the documentation for a more detailed introduction to the library.

    Definition Classes
    io
  • package pointer
    Definition Classes
    circe
  • object Pointer
    Definition Classes
    pointer
  • Absolute
  • Relative

sealed abstract class Relative extends Pointer

Represents a relative JSON Pointer.

Source
Pointer.scala
Linear Supertypes
Pointer, (ACursor) => ACursor, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Relative
  2. Pointer
  3. Function1
  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

Abstract Value Members

  1. abstract def apply(v1: ACursor): ACursor
    Definition Classes
    Function1
  2. abstract def distance: Int
  3. abstract def evaluate(c: ACursor): Either[PointerFailure, Result]
  4. abstract def getOption(input: Json): Option[Json]

    Attempt to get the value at the location pointed to.

    Attempt to get the value at the location pointed to.

    Definition Classes
    Pointer
    Note

    For absolute pointers this method may be faster than get or apply, since it does not have to track error locations.

  5. abstract def remainder: Option[Absolute]

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 Relative toany2stringadd[Relative] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Relative, B)
    Implicit
    This member is added by an implicit conversion from Relative toArrowAssoc[Relative] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def andThen[A](g: (ACursor) => A): (ACursor) => A
    Definition Classes
    Function1
    Annotations
    @unspecialized()
  7. final def asAbsolute: Option[Absolute]

    Return this pointer as a Pointer.Absolute if possible.

    Return this pointer as a Pointer.Absolute if possible.

    Definition Classes
    Relative → Pointer
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. final def asRelative: Option[Relative]

    Return this pointer as a Pointer.Relative if possible.

    Return this pointer as a Pointer.Relative if possible.

    Definition Classes
    Relative → Pointer
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  11. def compose[A](g: (A) => ACursor): (A) => ACursor
    Definition Classes
    Function1
    Annotations
    @unspecialized()
  12. def ensuring(cond: (Relative) => Boolean, msg: => Any): Relative
    Implicit
    This member is added by an implicit conversion from Relative toEnsuring[Relative] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: (Relative) => Boolean): Relative
    Implicit
    This member is added by an implicit conversion from Relative toEnsuring[Relative] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean, msg: => Any): Relative
    Implicit
    This member is added by an implicit conversion from Relative toEnsuring[Relative] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean): Relative
    Implicit
    This member is added by an implicit conversion from Relative toEnsuring[Relative] 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. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  19. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Relative toStringFormat[Relative] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  20. final def get(input: Json): Either[PointerFailure, Json]

    Attempt to get the value at the location pointed to, returning the history if it doesn't exist.

    Attempt to get the value at the location pointed to, returning the history if it doesn't exist.

    Definition Classes
    Pointer
  21. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  22. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. def navigateUp(c: ACursor, distance: Int): ACursor
    Attributes
    protected[this]
  25. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  28. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  29. def toString(): String
    Definition Classes
    Function1 → AnyRef → Any
  30. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

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

Inherited from (ACursor) => ACursor

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromRelative to any2stringadd[Relative]

Inherited by implicit conversion StringFormat fromRelative to StringFormat[Relative]

Inherited by implicit conversion Ensuring fromRelative to Ensuring[Relative]

Inherited by implicit conversion ArrowAssoc fromRelative to ArrowAssoc[Relative]

Ungrouped