caliban/caliban.schema

caliban.schema

package caliban.schema

Type members

Classlikes

object Annotations
@implicitNotFound("Cannot find an ArgBuilder for type ${T}.\n \nCaliban derives an ArgBuilder automatically for basic Scala types, case classes and sealed traits, but\nyou need to manually provide an implicit ArgBuilder for other types that could be nested in ${T}.\nSee https://ghostdogpr.github.io/caliban/docs/schema.html for more information.\n")
trait ArgBuilder[T]

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 of ArgBuilder.

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 of ArgBuilder.

Companion
object
object ArgBuilder extends ArgBuilderDerivation
Companion
class
trait ArgBuilderDerivation
case
class FieldAttributes(isInput: Boolean, isSubscription: Boolean)
trait GenericSchema[R] extends SchemaDerivation[R] with TemporalSchema
case
class Operation[-R](opType: `__Type`, plan: Step[R])
case
class PartiallyAppliedField[V](name: String, description: Option[String], directives: List[Directive]) extends PartiallyAppliedFieldBase[V]
abstract
class PartiallyAppliedFieldBase[V](name: String, description: Option[String], directives: List[Directive])
case
class PartiallyAppliedFieldLazy[V](name: String, description: Option[String], directives: List[Directive]) extends PartiallyAppliedFieldBase[V]
case
class PartiallyAppliedFieldWithArgs[V, A](name: String, description: Option[String], directives: List[Directive])
object PrintDerived
case
class PureStep(value: ResponseValue) extends Step[Any] with ReducedStep[Any]

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.

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 Params
value

the response value to return for that step

sealed
trait ReducedStep[-R]
Companion
object
object ReducedStep
Companion
class
case
class RootSchema[-R](query: Operation[R], mutation: Option[Operation[R]], subscription: Option[Operation[R]])
case
class RootSchemaBuilder[-R](query: Option[Operation[R]], mutation: Option[Operation[R]], subscription: Option[Operation[R]], additionalTypes: List[`__Type`])
case
class RootType(queryType: `__Type`, mutationType: Option[`__Type`], subscriptionType: Option[`__Type`], additionalTypes: List[`__Type`], additionalDirectives: List[`__Directive`])
@implicitNotFound("Cannot find a Schema for type ${T}.\n\nCaliban derives a Schema automatically for basic Scala types, case classes and sealed traits, but\nyou need to manually provide an implicit Schema for other types that could be nested in ${T}.\nIf you use a custom type as an argument, you also need to provide an implicit ArgBuilder for that type.\nSee https://ghostdogpr.github.io/caliban/docs/schema.html for more information.\n")
trait Schema[-R, T]

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).

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).

Companion
object
object Schema extends GenericSchema[Any]
Companion
class
trait SchemaDerivation[A]
sealed
trait Step[-R]
Companion
object
object Step
Companion
class
trait SubscriptionSchema[T]

Typeclass used to guarantee that the Subscriptions type is either Unit or a case class with zio.stream.ZStream for fields.

Typeclass used to guarantee that the Subscriptions type is either Unit or a case class with zio.stream.ZStream for fields.

Companion
object
object SubscriptionSchema extends SubscriptionSchemaDerivation
Companion
class
trait SubscriptionSchemaDerivation
trait TemporalSchema
object Types