caliban
API
Generated with
caliban/caliban/caliban.schema/GenericSchema

GenericSchema

caliban.schema.GenericSchema
trait GenericSchema[R] extends SchemaDerivation[R], TemporalSchema

Attributes

Graph
Supertypes
trait SchemaDerivation[R]
class Object
trait Matchable
class Any
Show all
Known subtypes
object Schema

Members list

Type members

Inherited classlikes

object Auto

Attributes

Inherited from:
SchemaDerivation
Supertypes
class Object
trait Matchable
class Any
case class DerivationConfig(enableSemanticNonNull: Boolean)

Attributes

Inherited from:
CommonSchemaDerivation
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final class SemiAuto[A](impl: Schema[R, A]) extends Schema[R, A]

Attributes

Inherited from:
SchemaDerivation
Supertypes
trait Schema[R, A]
class Object
trait Matchable
class Any
object SemiAuto

Attributes

Inherited from:
SchemaDerivation
Supertypes
class Object
trait Matchable
class Any

Inherited and Abstract classlikes

sealed abstract class Auto[A] extends Schema[R, A]

Attributes

Inherited from:
SchemaDerivation
Supertypes
trait Schema[R, A]
class Object
trait Matchable
class Any

Value members

Concrete methods

def customErrorEffectSchema[R0, R1 >: R0, R2 >: R0, E, A](convertError: E => ExecutionError)(implicit ev: Schema[R2, A]): Schema[R0, ZIO[R1, E, A]]
def customErrorQuerySchema[R0, R1 >: R0, R2 >: R0, E, A](convertError: E => ExecutionError)(implicit ev: Schema[R2, A]): Schema[R0, ZQuery[R1, E, A]]
def customErrorStreamSchema[R0, R1 >: R0, R2 >: R0, E, A](convertError: E => ExecutionError)(implicit ev: Schema[R2, A]): Schema[R0, ZStream[R1, E, A]]
def enumSchema[A](name: String, description: Option[String], values: List[`__EnumValue`], directives: List[Directive], repr: A => String): Schema[Any, A]

Creates an enum schema for a type A

Creates an enum schema for a type A

Value parameters

description

description of the scalar type

directives

the directives to add to the type

name

name of the scalar type

repr

function that defines how to convert A into a string. WARNING: The resulting string must be contained in the values list

values

list of possible enum values

Attributes

See also

enumValue convenience method for creating enum values required by this method

def enumValue(name: String, description: Option[String], isDeprecated: Boolean, deprecationReason: Option[String], directives: List[Directive]): `__EnumValue`
def field[V](name: String, description: Option[String], directives: List[Directive]): PartiallyAppliedField[V]

Manually defines a field from a name, a description, some directives and a resolver. If the field is a function that should be called lazily, use fieldLazy instead. If the field takes arguments, use fieldWithArgs instead.

Manually defines a field from a name, a description, some directives and a resolver. If the field is a function that should be called lazily, use fieldLazy instead. If the field takes arguments, use fieldWithArgs instead.

Attributes

def fieldLazy[V](name: String, description: Option[String], directives: List[Directive]): PartiallyAppliedFieldLazy[V]

Manually defines a lazy field from a name, a description, some directives and a resolver.

Manually defines a lazy field from a name, a description, some directives and a resolver.

Attributes

def fieldWithArgs[V, A](name: String, description: Option[String], directives: List[Directive]): PartiallyAppliedFieldWithArgs[V, A]

Manually defines a field with arguments from a name, a description, some directives and a resolver.

Manually defines a field with arguments from a name, a description, some directives and a resolver.

Attributes

def obj[R1, V](name: String, description: Option[String], directives: List[Directive])(fields: FieldAttributes => List[(`__Field`, V => Step[R1])]): Schema[R1, V]

Creates a new hand-rolled schema. For normal usage use the derived schemas, this is primarily for schemas which can't be resolved by derivation.

Creates a new hand-rolled schema. For normal usage use the derived schemas, this is primarily for schemas which can't be resolved by derivation.

Value parameters

description

An optional description of the type

directives

The directives to add to the type

fields

The fields to add to this object

case class Group(id: String, users: UQuery[List[User]], parent: UQuery[Option[Group]], organization: UQuery[Organization])
case class Organization(id: String, groups: UQuery[List[Group]])
case class User(id: String, group: UQuery[Group])
implicit val groupSchema: Schema[Any, Group] = obj("Group", Some("A group of users"))(implicit ft =>
  List(
    field("id")(_.id),
    field("users")(_.users),
    field("parent")(_.parent),
    field("organization")(_.organization)
  )
)
implicit val orgSchema: Schema[Any, Organization] = obj("Organization", Some("An organization of groups"))(implicit ft =>
  List(
    field("id")(_.id),
    field("groups")(_.groups)
  )
)
implicit val userSchema: Schema[Any, User] = obj("User", Some("A user of the service"))(implicit ft =>
  List(
    field("id")(_.id),
    field("group")(_.group)
  )
)
name

The name of the type

Attributes

See also

customObj for an improved variant using context functions (Scala 3 only)

def objectSchema[R1, A](name: String, description: Option[String], fields: (Boolean, Boolean) => List[(`__Field`, A => Step[R1])], directives: List[Directive]): Schema[R1, A]

Creates an object schema for a type A

Creates an object schema for a type A

Value parameters

description

description of the type

fields

list of fields with a type description and a resolver for each field

name

name of the type

Attributes

def scalarSchema[A](name: String, description: Option[String], specifiedBy: Option[String], directives: Option[List[Directive]], makeResponse: A => ResponseValue): Schema[Any, A]

Creates a scalar schema for a type A

Creates a scalar schema for a type A

Value parameters

description

description of the scalar type

directives

the directives to add to the type

makeResponse

function from A to ResponseValue that defines how to resolve A

name

name of the scalar type

specifiedBy

URL of the scalar specification

Attributes

Inherited methods

inline def apply[A]: Schema[R, A]

Attributes

Inherited from:
SchemaDerivation
def config: DerivationConfig

Returns a configuration object that can be used to customize the derivation behavior.

Returns a configuration object that can be used to customize the derivation behavior.

Override this method to customize the configuration.

Attributes

Inherited from:
CommonSchemaDerivation
inline def derived[R, A]: Schema[R, A]

Attributes

Inherited from:
CommonSchemaDerivation
inline def gen[R, A]: Schema[R, A]

Attributes

Inherited from:
SchemaDerivation
inline def genDebug[R, A]: Schema[R, A]

Attributes

Inherited from:
SchemaDerivation
def localDateSchemaWithFormatter(formatter: DateTimeFormatter): Schema[Any, LocalDate]

Attributes

Inherited from:
TemporalSchema
def localDateTimeSchemaWithFormatter(formatter: DateTimeFormatter): Schema[Any, LocalDateTime]

Attributes

Inherited from:
TemporalSchema
def localTimeSchemaWithFormatter(formatter: DateTimeFormatter): Schema[Any, LocalTime]

Attributes

Inherited from:
TemporalSchema
def offsetDateTimeSchemaWithFormatter(formatter: DateTimeFormatter): Schema[Any, OffsetDateTime]

Attributes

Inherited from:
TemporalSchema
transparent inline def recurseProduct[R, P, Label <: Tuple, A <: Tuple](inline values: List[ProductFieldInfo[R]])(inline index: Int): List[ProductFieldInfo[R]]

Attributes

Inherited from:
CommonSchemaDerivation
transparent inline def recurseSum[R, P, Label <: Tuple, A <: Tuple](inline types: List[(String, `__Type`, List[Any])], inline schemas: List[Schema[R, Any]]): (List[(String, `__Type`, List[Any])], List[Schema[R, Any]])

Attributes

Inherited from:
CommonSchemaDerivation
def temporalSchema[A <: Temporal](name: String, description: Option[String])(f: A => ResponseValue): Schema[Any, A]

Attributes

Inherited from:
TemporalSchema
def temporalSchemaWithFormatter[A <: Temporal](name: String, description: Option[String])(formatter: DateTimeFormatter): Schema[Any, A]

Attributes

Inherited from:
TemporalSchema
inline def unionType[T]: Schema[R, T]

Attributes

Inherited from:
SchemaDerivation
transparent inline def valueTypeSchema[R, Label <: Tuple, A <: Tuple]: Schema[R, Any]

Attributes

Inherited from:
CommonSchemaDerivation
def zonedDateTimeSchemaWithFormatter(formatter: DateTimeFormatter): Schema[Any, ZonedDateTime]

Attributes

Inherited from:
TemporalSchema

Inherited fields

final lazy val auto: AutoSchemaDerivation[Any]

Attributes

Inherited from:
SchemaDerivation
lazy val instantEpochSchema: Schema[Any, Instant]

Attributes

Inherited from:
TemporalSchema
val localDateEpochSchema: Schema[Any, LocalDate]

Attributes

Inherited from:
TemporalSchema
val localDateTimeEpochSchema: Schema[Any, LocalDateTime]

Attributes

Inherited from:
TemporalSchema
lazy val sampleDate: ZonedDateTime

Attributes

Inherited from:
TemporalSchema

Implicits

Implicits

implicit val base64CursorSchema: Schema[Any, Base64Cursor]
implicit val bigDecimalSchema: Schema[Any, BigDecimal]
implicit val bigIntSchema: Schema[Any, BigInt]
implicit val booleanSchema: Schema[Any, Boolean]
implicit def chunkSchema[R0, A](implicit ev: Schema[R0, A]): Schema[R0, Chunk[A]]
implicit val doubleSchema: Schema[Any, Double]
implicit def effectSchema[R0, R1 >: R0, R2 >: R0, E <: Throwable, A](implicit ev: Schema[R2, A]): Schema[R0, ZIO[R1, E, A]]
implicit def eitherSchema[RA, RB, A, B](implicit evA: Schema[RA, A], evB: Schema[RB, B]): Schema[RA & RB, Either[A, B]]
implicit val floatSchema: Schema[Any, Float]
implicit def functionSchema[RA, RB, A, B](implicit arg1: ArgBuilder[A], ev1: Schema[RA, A], ev2: Schema[RB, B]): Schema[RB, A => B]
implicit def functionUnitSchema[R0, A](implicit ev: Schema[R0, A]): Schema[R0, () => A]
implicit def futureSchema[R0, A](implicit ev: Schema[R0, A]): Schema[R0, Future[A]]
implicit def infallibleEffectSchema[R0, R1 >: R0, R2 >: R0, A](implicit ev: Schema[R2, A]): Schema[R0, URIO[R1, A]]
implicit def infallibleQuerySchema[R0, R1 >: R0, R2 >: R0, A](implicit ev: Schema[R2, A]): Schema[R0, ZQuery[R1, Nothing, A]]
implicit def infallibleStreamSchema[R1, R2 >: R1, A](implicit ev: Schema[R2, A]): Schema[R1, ZStream[R1, Nothing, A]]
implicit val intSchema: Schema[Any, Int]
implicit def listSchema[R0, A](implicit ev: Schema[R0, A]): Schema[R0, List[A]]
implicit val longSchema: Schema[Any, Long]
implicit def mapSchema[RA, RB, A, B](implicit evA: Schema[RA, A], evB: Schema[RB, B]): Schema[RA & RB, Map[A, B]]
implicit def metadataFunctionSchema[R0, A](implicit ev: Schema[R0, A]): Schema[R0, Field => A]
implicit def nonEmptyChunkSchema[R0, A](implicit ev: Schema[R0, A]): Schema[R0, NonEmptyChunk[A]]
implicit def optionSchema[R0, A](implicit ev: Schema[R0, A]): Schema[R0, Option[A]]
implicit def querySchema[R0, R1 >: R0, R2 >: R0, E <: Throwable, A](implicit ev: Schema[R2, A]): Schema[R0, ZQuery[R1, E, A]]
implicit def seqSchema[R0, A](implicit ev: Schema[R0, A]): Schema[R0, Seq[A]]
implicit def setSchema[R0, A](implicit ev: Schema[R0, A]): Schema[R0, Set[A]]
implicit val shortSchema: Schema[Any, Short]
implicit def streamSchema[R0, R1 >: R0, R2 >: R0, E <: Throwable, A](implicit ev: Schema[R2, A]): Schema[R0, ZStream[R1, E, A]]
implicit val stringSchema: Schema[Any, String]
implicit def tupleSchema[RA, RB, A, B](implicit evA: Schema[RA, A], evB: Schema[RB, B]): Schema[RA & RB, (A, B)]
implicit val unitSchema: Schema[Any, Unit]
implicit val uploadSchema: Schema[Any, Upload]
implicit val uuidSchema: Schema[Any, UUID]
implicit def vectorSchema[R0, A](implicit ev: Schema[R0, A]): Schema[R0, Vector[A]]

Inherited implicits

implicit lazy val instantSchema: Schema[Any, Instant]

Attributes

Inherited from:
TemporalSchema
implicit lazy val localDateSchema: Schema[Any, LocalDate]

Attributes

Inherited from:
TemporalSchema
implicit lazy val localDateTimeSchema: Schema[Any, LocalDateTime]

Attributes

Inherited from:
TemporalSchema
implicit lazy val localTimeSchema: Schema[Any, LocalTime]

Attributes

Inherited from:
TemporalSchema
implicit lazy val offsetDateTimeSchema: Schema[Any, OffsetDateTime]

Attributes

Inherited from:
TemporalSchema
implicit lazy val zonedDateTimeSchema: Schema[Any, ZonedDateTime]

Attributes

Inherited from:
TemporalSchema
Generated with