trait Cursor extends AnyRef

Indicates a position within an abstract data model during the interpretation of a GraphQL query.

Linear Supertypes
AnyRef, Any
Known Subclasses
ComposedCursor, AbstractCursor, DeferredCursor, EmptyCursor, ListTransformCursor, ProxyCursor, LeafCursor, RootCursor, ValueCursor
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Cursor
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def asLeaf: Result[Json]

    Yield the value at this Cursor rendered as Json if it is of a scalar or enum type, an error or the left hand side otherwise.

  2. abstract def asList[C](factory: Factory[Cursor, C]): Result[C]

    Yield a collection of Cursors corresponding to the elements of the value at this Cursor if it is of a list type, or an error or the left hand side otherwise.

  3. abstract def asNullable: Result[Option[Cursor]]

    Yield an optional Cursors corresponding to the value at this Cursor if it is of a nullable type, or an error on the left hand side otherwise.

    Yield an optional Cursors corresponding to the value at this Cursor if it is of a nullable type, or an error on the left hand side otherwise. The resulting Cursor will be present iff the current value is present in the model.

  4. abstract def context: Context

    The Context associated with this Cursor.

  5. abstract def field(fieldName: String, resultName: Option[String]): Result[Cursor]

    Yield a Cursor corresponding to the value of the field fieldName of the value at this Cursor, or an error on the left hand side if there is no such field.

  6. abstract def focus: Any

    The value at the position represented by this Cursor.

  7. abstract def hasField(fieldName: String): Boolean

    Does the value at this Cursor have a field named fieldName?

  8. abstract def isDefined: Result[Boolean]

    Yields whether or not this Cursor is defined if it is of a nullable type, or an error otherwise.

  9. abstract def isLeaf: Boolean

    Is the value at this Cursor of a scalar or enum type?

  10. abstract def isList: Boolean

    Is the value at this Cursor of a list type?

  11. abstract def isNullable: Boolean

    Is the value at this Cursor of a nullable type?

  12. abstract def listSize: Result[Int]

    Yields the number of elements of this Cursor if it is of a list type, or an error otherwise.

  13. abstract def narrow(subtpe: TypeRef): Result[Cursor]

    Yield a Cursor corresponding to the value at this Cursor narrowed to type subtpe, or an error on the left hand side if such a narrowing is not possible.

  14. abstract def narrowsTo(subtpe: TypeRef): Boolean

    Is the value at this Cursor narrowable to subtpe?

  15. abstract def parent: Option[Cursor]

    The parent of this Cursor

  16. abstract def preunique: Result[Cursor]

    Yield a Cursor which can be used to evaluate the antecedant of a Unique operation.

  17. abstract def withEnv(env: Env): Cursor

    Yields a copy of this Cursor with the supplied additional environment values.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def as[T](implicit arg0: ClassTag[T]): Result[T]

    Yield the value at this Cursor as a value of type T if possible, an error or the left hand side otherwise.

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. final def asList: Result[List[Cursor]]

    Yield a list of Cursors corresponding to the elements of the value at this Cursor if it is of a list type, or an error or the left hand side otherwise.

  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. def env[T](nme: String)(implicit arg0: ClassTag[T]): Option[T]

    Yields the value of the supplied environment key, if any.

  9. def envContains(nme: String): Boolean
  10. def envR[T](nme: String)(implicit arg0: ClassTag[T], arg1: TypeName[T]): Result[T]

    Yields the value of the supplied environment key, if any, or an error if none.

  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  13. def fieldAs[T](fieldName: String)(implicit arg0: ClassTag[T]): Result[T]

    Yield the value of the field fieldName of this Cursor as a value of type T if possible, an error or the left hand side otherwise.

  14. def flatListPath(fns: List[String]): Result[List[Cursor]]

    Yield a list of Cursors corresponding to the values generated by following the path fns from the value at this Cursor, or an error on the left hand side if there is no such path.

    Yield a list of Cursors corresponding to the values generated by following the path fns from the value at this Cursor, or an error on the left hand side if there is no such path. If the field at the end of the path is a list then yield the concatenation of the lists of cursors corresponding to the field elements.

  15. def fullEnv: Env

    Yields the cumulative environment defined at this Cursor.

  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. def hasListPath(fns: List[String]): Boolean

    Does the value at this Cursor generate a list along the path fns?

    Does the value at this Cursor generate a list along the path fns?

    true if fns is a valid path from the value at this Cursor and passes through at least one field with a list type.

  18. def hasPath(fns: List[String]): Boolean

    Does the value at this Cursor have a field identified by the path fns?

  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. def isNull: Boolean

    True if this cursor is nullable and null, false otherwise.

  22. def listPath(fns: List[String]): Result[List[Cursor]]

    Yield a list of Cursors corresponding to the values generated by following the path fns from the value at this Cursor, or an error on the left hand side if there is no such path.

  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  26. def nullableField(fieldName: String): Result[Cursor]

    Yield a Cursor corresponding to the value of the possibly nullable field fieldName of the value at this Cursor, or an error on the left hand side if there is no such field.

  27. def nullableHasField(fieldName: String): Boolean

    Does the possibly nullable value at this Cursor have a field named fieldName?

  28. def path(fns: List[String]): Result[Cursor]

    Yield a Cursor corresponding to the value of the field identified by path fns starting from the value at this Cursor, or an error on the left hand side if there is no such field.

  29. def path: List[String]

    The selection path from the root

  30. def resultPath: List[String]

    The selection path from the root modified by query aliases.

  31. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  32. def toString(): String
    Definition Classes
    AnyRef → Any
  33. def tpe: Type

    The GraphQL type of the value at the position represented by this Cursor.

  34. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  35. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  36. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped