caliban
API
Generated with
caliban/caliban

caliban

package caliban

Members list

Packages

package caliban.execution
package caliban.interop
package caliban.introspection
package caliban.parsing
package caliban.relay
package caliban.rendering
package caliban.schema
package caliban.transformers
package caliban.uploads
package caliban.validation
package caliban.wrappers
package caliban.ws

Type members

Classlikes

sealed trait CalibanError extends NoStackTrace, Product, Serializable

The base type for all Caliban errors.

The base type for all Caliban errors.

Attributes

Companion
object
Supertypes
trait Product
trait Equals
trait NoStackTrace
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
Known subtypes
class ParsingError
object CalibanError

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
object Configurator

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
trait GraphQL[-R]

A GraphQL[-R] represents a GraphQL API whose execution requires a ZIO environment of type R.

A GraphQL[-R] represents a GraphQL API whose execution requires a ZIO environment of type R.

It is intended to be created only once, typically when you start your server. The introspection schema will be generated when this class is instantiated.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
GraphQL[R]
trait GraphQLAspect[+LowerR, -UpperR]

A GraphQLAspect is wrapping type similar to a polymorphic function, which is capable of transforming a GraphQL into another while possibly enlarging the required environment type. It allows a flexible way to augment an existing GraphQL with new capabilities or features.

A GraphQLAspect is wrapping type similar to a polymorphic function, which is capable of transforming a GraphQL into another while possibly enlarging the required environment type. It allows a flexible way to augment an existing GraphQL with new capabilities or features.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait Wrapper[R]
class CombinedWrapper[R]
class EffectfulWrapper[R]
object Empty
class FieldWrapper[R]
trait SimpleWrapper[R, E, A, Info]
trait ExecutionWrapper[R]
trait OverallWrapper[R]
trait ParsingWrapper[R]
Show all
Self type
GraphQLAspect[LowerR, UpperR]
object GraphQLAspect

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
case class GraphQLIncrementalResponse[+E](incremental: List[Incremental[E]], hasNext: Boolean)

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object GraphQLIncrementalResponse

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
trait GraphQLInterpreter[-R, +E]

A GraphQLInterpreter[-R, +E] represents a GraphQL interpreter whose execution requires a ZIO environment of type R and can fail with an E.

A GraphQLInterpreter[-R, +E] represents a GraphQL interpreter whose execution requires a ZIO environment of type R and can fail with an E.

It is a wrapper around a GraphQL API definition that allows adding some middleware around query execution, and possibly transform the environment or the error type.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Self type
object GraphQLInterpreter

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
case class GraphQLRequest(query: Option[String] = ..., operationName: Option[String] = ..., variables: Option[Map[String, InputValue]] = ..., extensions: Option[Map[String, InputValue]] = ..., isHttpGetRequest: Boolean = ...)

Represents a GraphQL request, containing a query, an operation name and a map of variables.

Represents a GraphQL request, containing a query, an operation name and a map of variables.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
object GraphQLRequest

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class GraphQLResponse[+E](data: ResponseValue, errors: List[E], extensions: Option[ObjectValue] = ..., hasNext: Option[Boolean] = ...)

Represents the result of a GraphQL query, containing a data object and a list of errors.

Represents the result of a GraphQL query, containing a data object and a list of errors.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object GraphQLResponse

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class GraphQLWSClose(code: Int, reason: String)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class GraphQLWSInput(`type`: String, id: Option[String], payload: Option[InputValue])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object GraphQLWSInput

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class GraphQLWSOutput(`type`: String, id: Option[String], payload: Option[ResponseValue])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object GraphQLWSOutput

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object Hash

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Hash.type
sealed trait Incremental[+E] extends Product, Serializable

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
class Defer[E]
class Stream[E]
object Incremental

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait InputValue extends Serializable

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any
Known subtypes
class ListValue
class ObjectValue
trait Value
trait PathValue
class IntNumber
class StringValue
class BooleanValue
class EnumValue
trait FloatValue
class DoubleNumber
class FloatNumber
trait IntValue
class BigIntNumber
class LongNumber
object NullValue
Show all
Self type
object InputValue

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
InputValue.type
object Macros

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Macros.type
sealed trait PathValue extends Value

Attributes

Companion
object
Supertypes
trait Value
trait InputValue
trait Serializable
class Object
trait Matchable
class Any
Show all
Known subtypes
class IntNumber
class StringValue
object PathValue

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
PathValue.type
sealed trait ResponseValue extends Serializable

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any
Known subtypes
class ListValue
class ObjectValue
class StreamValue
trait Value
trait PathValue
class IntNumber
class StringValue
class BooleanValue
class EnumValue
trait FloatValue
class DoubleNumber
class FloatNumber
trait IntValue
class BigIntNumber
class LongNumber
object NullValue
Show all
Self type
object ResponseValue

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
case class RootResolver[+Query, +Mutation, +Subscription](queryResolver: Option[Query], mutationResolver: Option[Mutation], subscriptionResolver: Option[Subscription])

A root resolver contains resolvers for the 3 types of operations allowed in GraphQL: queries, mutations and subscriptions.

A root resolver contains resolvers for the 3 types of operations allowed in GraphQL: queries, mutations and subscriptions.

A resolver is a simple value of the case class describing the API.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object RootResolver

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait Value extends InputValue, ResponseValue

Attributes

Companion
object
Supertypes
trait InputValue
trait Serializable
class Object
trait Matchable
class Any
Show all
Known subtypes
trait PathValue
class IntNumber
class StringValue
class BooleanValue
class EnumValue
trait FloatValue
class DoubleNumber
class FloatNumber
trait IntValue
class BigIntNumber
class LongNumber
object NullValue
Show all
object Value

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Value.type

Value members

Concrete methods

def graphQL[R, Q, M, S : SubscriptionSchema](resolver: RootResolver[Q, M, S], directives: List[`__Directive`] = ..., schemaDirectives: List[Directive] = ..., schemaDescription: Option[String] = ...)(implicit evidence$1: SubscriptionSchema[S], querySchema: Schema[R, Q], mutationSchema: Schema[R, M], subscriptionSchema: Schema[R, S]): GraphQL[R]

Builds a GraphQL API for the given resolver.

Builds a GraphQL API for the given resolver.

It requires an instance of caliban.schema.Schema for each operation type. This schema will be derived by Magnolia automatically.

Attributes

def render[T](implicit schema: Schema[Any, T]): String

Returns a string that renders the given type into the GraphQL SDL.

Returns a string that renders the given type into the GraphQL SDL.

Attributes

def renderSchema[Q, M, S](directives: List[`__Directive`] = ..., schemaDirectives: List[Directive] = ..., schemaDescription: Option[String] = ...)(implicit querySchema: Schema[Any, Q], mutationSchema: Schema[Any, M], subscriptionSchema: Schema[Any, S]): String

Returns a string that renders the given schema into the GraphQL SDL.

Returns a string that renders the given schema into the GraphQL SDL.

Attributes

def renderSchemaWith[R, Q, M, S](directives: List[`__Directive`] = ..., schemaDirectives: List[Directive] = ..., schemaDescription: Option[String] = ...)(implicit querySchema: Schema[R, Q], mutationSchema: Schema[R, M], subscriptionSchema: Schema[R, S]): String

Returns a string that renders the given schema into the GraphQL SDL. This variant of the method allows specifying the environment type when it's not Any.

Returns a string that renders the given schema into the GraphQL SDL. This variant of the method allows specifying the environment type when it's not Any.

Attributes

def renderWith[R, T](implicit schema: Schema[R, T]): String

Returns a string that renders the given type into the GraphQL SDL. This variant of the method allows specifying the environment type when it's not Any.

Returns a string that renders the given type into the GraphQL SDL. This variant of the method allows specifying the environment type when it's not Any.

Attributes

Generated with