Cursor

trait Cursor

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

Companion:
object
Source:
cursor.scala
class Object
trait Matchable
class Any

Value members

Abstract methods

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.

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.

Source:
cursor.scala
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.

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.

Source:
cursor.scala

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.

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.

Source:
cursor.scala

The Context associated with this Cursor.

The Context associated with this Cursor.

Source:
cursor.scala
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.

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.

Source:
cursor.scala
def focus: Any

The value at the position represented by this Cursor.

The value at the position represented by this Cursor.

Source:
cursor.scala
def hasField(fieldName: String): Boolean

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

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

Source:
cursor.scala

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

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

Source:
cursor.scala

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

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

Source:
cursor.scala

Is the value at this Cursor of a list type?

Is the value at this Cursor of a list type?

Source:
cursor.scala

Is the value at this Cursor of a nullable type?

Is the value at this Cursor of a nullable type?

Source:
cursor.scala

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

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

Source:
cursor.scala
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.

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.

Source:
cursor.scala
def narrowsTo(subtpe: TypeRef): Boolean

Is the value at this Cursor narrowable to subtpe?

Is the value at this Cursor narrowable to subtpe?

Source:
cursor.scala

The parent of this Cursor

The parent of this Cursor

Source:
cursor.scala

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

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

Source:
cursor.scala
def withEnv(env: Env): Cursor

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

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

Source:
cursor.scala

Concrete methods

def as[T : ClassTag]: Result[T]

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

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

Source:
cursor.scala
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.

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.

Source:
cursor.scala
def env[T : ClassTag](nme: String): Option[T]

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

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

Source:
cursor.scala
def envR[T : TypeName](nme: String): Result[T]

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

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

Source:
cursor.scala
def fieldAs[T : ClassTag](fieldName: String): 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.

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.

Source:
cursor.scala

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.

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.

Source:
cursor.scala

Yields the cumulative environment defined at this Cursor.

Yields the cumulative environment defined at this Cursor.

Source:
cursor.scala

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.

Source:
cursor.scala

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

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

Source:
cursor.scala

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

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

Source:
cursor.scala

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.

Source:
cursor.scala
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.

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.

Source:
cursor.scala

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

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

Source:
cursor.scala

The selection path from the root

The selection path from the root

Source:
cursor.scala

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.

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.

Source:
cursor.scala

The selection path from the root modified by query aliases.

The selection path from the root modified by query aliases.

Source:
cursor.scala
def tpe: Type

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

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

Source:
cursor.scala