package schema
- Alphabetic
- Public
- Protected
Type Members
- trait ArgBuilder[T] extends AnyRef
Typeclass that defines how to build an argument of type
T
from an input caliban.InputValue.Typeclass that defines how to build an argument of type
T
from an input caliban.InputValue. Every type that can be passed as an argument needs an instance ofArgBuilder
.- Annotations
- @implicitNotFound("""Cannot find an ArgBuilder for type ${T}.
Caliban derives an ArgBuilder automatically for basic Scala types, case classes and sealed traits, but
you need to manually provide an implicit ArgBuilder for other types that could be nested in ${T}.
See https://ghostdogpr.github.io/caliban/docs/schema.html for more information.
""")
- trait DerivationSchema[R] extends AnyRef
- trait GenericSchema[R] extends DerivationSchema[R]
- case class Operation[-R](opType: __Type, plan: Step[R]) extends Product with Serializable
- case class PureStep(value: ResponseValue) extends Step[Any] with ReducedStep[Any] with Product with Serializable
Represents the step of getting a pure response value without any effect.
Represents the step of getting a pure response value without any effect. PureStep is both a Step and a ReducedStep to avoid boxing/unboxing pure values during step reduction.
- value
the response value to return for that step
- sealed trait ReducedStep[-R] extends AnyRef
- case class RootSchema[-R](query: Operation[R], mutation: Option[Operation[R]], subscription: Option[Operation[R]]) extends Product with Serializable
- case class RootSchemaBuilder[-R](query: Option[Operation[R]], mutation: Option[Operation[R]], subscription: Option[Operation[R]]) extends Product with Serializable
- case class RootType(queryType: __Type, mutationType: Option[__Type], subscriptionType: Option[__Type], additionalDirectives: List[__Directive] = List.empty) extends Product with Serializable
- trait Schema[-R, T] extends AnyRef
Typeclass that defines how to map the type
T
to the according GraphQL concepts: how to introspect it and how to resolve it.Typeclass that defines how to map the type
T
to the according GraphQL concepts: how to introspect it and how to resolve it.R
is the ZIO environment required by the effects in the schema (Any
if nothing required).- Annotations
- @implicitNotFound("""Cannot find a Schema for type ${T}.
Caliban derives a Schema automatically for basic Scala types, case classes and sealed traits, but
you need to manually provide an implicit Schema for other types that could be nested in ${T}.
If you use a custom type as an argument, you also need to provide an implicit ArgBuilder for that type.
See https://ghostdogpr.github.io/caliban/docs/schema.html for more information.
""")
- sealed trait Step[-R] extends AnyRef
- trait SubscriptionSchema[-T] extends AnyRef
Typeclass used to guarantee that the Subscriptions type is either
Unit
or a case class withzio.stream.ZStream
for fields.
Value Members
- object Annotations
- object ArgBuilder
- object ReducedStep
- object Schema extends GenericSchema[Any]
- object Step
- object SubscriptionSchema
- object Types