Mapping

abstract class Mapping[F[_]] extends QueryExecutor[F, Json]
class Object
trait Matchable
class Any

Type members

Classlikes

case class CursorField[T](fieldName: String, f: Cursor => Result[T], encoder: Encoder[T], required: List[String], hidden: Boolean)(implicit pos: SourcePos) extends FieldMapping
Companion:
object
Source:
mapping.scala
Companion:
class
Source:
mapping.scala
case class Delegate(fieldName: String, interpreter: Mapping[F], join: (Cursor, Query) => Result[Query])(implicit pos: SourcePos) extends FieldMapping
case class LeafCursor(context: Context, focus: Any, parent: Option[Cursor], env: Env) extends Cursor

Cursor positioned at a GraphQL result leaf

Cursor positioned at a GraphQL result leaf

Source:
mapping.scala
Companion:
class
Source:
mapping.scala
trait LeafMapping[T] extends TypeMapping
Companion:
object
Source:
mapping.scala
abstract class ObjectMapping extends TypeMapping
Companion:
object
Source:
mapping.scala
Companion:
class
Source:
mapping.scala
case class PrefixedMapping(tpe: Type, mappings: List[(List[String], ObjectMapping)])(implicit pos: SourcePos) extends TypeMapping
case class PrimitiveField(fieldName: String, hidden: Boolean)(implicit pos: SourcePos) extends FieldMapping
case class PrimitiveMapping(tpe: Type)(implicit pos: SourcePos) extends TypeMapping
case class RootCursor(context: Context, parent: Option[Cursor], env: Env) extends AbstractCursor

Root Cursor focussed on the top level operation of a query

Root Cursor focussed on the top level operation of a query

Construction of mapping-specific cursors is handled by delegation to mkCursorForField which is typically overridden inMapping` subtypes.

Source:
mapping.scala
case class RootEffect extends FieldMapping

Root effects can perform an intial effect prior to computing the resulting Cursor and effective Query.

Root effects can perform an intial effect prior to computing the resulting Cursor and effective Query.

Convenience methods are provided to cover the cases where only one of the query or the cursor are computed, and for where the computation is one-shot or a Stream. One-shot effects are used to perform initial effectful setup for a query or to perform the effect associated with a GraphQL mutation. Stream effects are used for GraphQL subscriptions.

If only the query is computed the default root cursor for the mapping will be used. If only the cursor is computed the client query (after elaboration) is used unmodified ... in this case results of the performed effect can only be passed to the result construction stage via the environment associated with the returned cursor.

Companion:
object
Source:
mapping.scala
object RootEffect
Companion:
class
Source:
mapping.scala

Value members

Concrete methods

def compileAndRunAll(text: String, name: Option[String], untypedVars: Option[Json], introspectionLevel: IntrospectionLevel, env: Env): Stream[F, Json]
def compileAndRunOne(text: String, name: Option[String], untypedVars: Option[Json], introspectionLevel: IntrospectionLevel, env: Env)(implicit sc: Compiler[F, F]): F[Json]
def defaultRootCursor(query: Query, tpe: Type, env: Env): F[Result[(Query, Cursor)]]

Yields a Cursor focused on the top level operation type of the query

Yields a Cursor focused on the top level operation type of the query

Source:
mapping.scala
def fieldMapping(context: Context, fieldName: String): Option[FieldMapping]
def isLeaf(tpe: Type): Boolean

True if the supplied type is a leaf with respect to the GraphQL schema or mapping, false otherwise.

True if the supplied type is a leaf with respect to the GraphQL schema or mapping, false otherwise.

Source:
mapping.scala
def mkCursorForField(parent: Cursor, fieldName: String, resultName: Option[String]): Result[Cursor]

Yields a Cursor suitable for traversing the query result corresponding to the fieldName child of parent.

Yields a Cursor suitable for traversing the query result corresponding to the fieldName child of parent.

This method is typically overridden in and delegated to by Mapping subtypes.

Source:
mapping.scala
def rootEffect(context: Context, fieldName: String): Option[RootEffect]

Yields the RootEffect, if any, associated with fieldName.

Yields the RootEffect, if any, associated with fieldName.

Source:
mapping.scala
def run(query: Query, rootTpe: Type, env: Env): Stream[F, Json]
def run(op: Operation, env: Env): Stream[F, Json]

Inherited methods

def compileAndRun(text: String, name: Option[String], untypedVars: Option[Json], introspectionLevel: IntrospectionLevel, env: Env)(implicit sc: Compiler[F, F]): F[Json]
Inherited from:
QueryExecutor
Source:
mapping.scala

Implicits

Implicits

implicit val M: Monad[F]