caliban-client/caliban.client

caliban.client

package caliban.client

Type members

Classlikes

@implicitNotFound("Cannot find an ArgEncoder for type ${A}.\n\nCaliban needs it to know how to encode arguments of type ${A}.\n")
trait ArgEncoder[-A]

Typeclass that defines how to encode an argument of type A into a valid caliban.client.__Value. Every type that can be passed as an argument needs an instance of ArgEncoder.

Typeclass that defines how to encode an argument of type A into a valid caliban.client.__Value. Every type that can be passed as an argument needs an instance of ArgEncoder.

Companion:
object
object ArgEncoder
Companion:
class
case class Argument[+A](name: String, value: A, typeInfo: String)(implicit encoder: ArgEncoder[A])

Represents an argument in a GraphQL query. Requires an encoder for the argument type.

Represents an argument in a GraphQL query. Requires an encoder for the argument type.

Companion:
object
object Argument
Companion:
class
sealed trait CalibanClientError extends Throwable with Product with Serializable

The base type for all Caliban Client errors.

The base type for all Caliban Client errors.

Companion:
object
object CalibanClientError
Companion:
class
trait FieldBuilder[+A]

Represents a single field that returns a result of type A.

Represents a single field that returns a result of type A.

Companion:
object
object FieldBuilder
Companion:
class
case class GraphQLRequest(query: String, variables: Map[String, `__Value`])

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

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

Companion:
object
object GraphQLRequest
Companion:
class
case class GraphQLResponse(data: Option[`__Value`], errors: List[GraphQLResponseError], extensions: Option[Json])

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.

Companion:
object
object GraphQLResponse
Companion:
class
case class GraphQLResponseError(message: String, locations: Option[List[Location]], path: Option[List[Either[String, Int]]], extensions: Option[Json])

An GraphQL error as returned by the server.

An GraphQL error as returned by the server.

Value parameters:
locations

line and column that caused the error in the initial query

message

error message

path

path of the field that caused the error

Companion:
object
object GraphQLResponseError
Companion:
class
object IntrospectionClient
object Operations
@implicitNotFound("Cannot find a ScalarDecoder for type ${A}.\n\nCaliban needs it to know how to decode a scalar of type ${A}.\n")
trait ScalarDecoder[+A]

Typeclass that defines how to decode a scalar from a GraphQL response into a proper value of type A.

Typeclass that defines how to decode a scalar from a GraphQL response into a proper value of type A.

Companion:
object
object ScalarDecoder
Companion:
class
sealed trait Selection
Companion:
object
object Selection
Companion:
class
sealed trait SelectionBuilder[-Origin, +A]

Represents a selection from parent type Origin that returns a result of type A.

Represents a selection from parent type Origin that returns a result of type A.

Companion:
object
object SelectionBuilder
Companion:
class
trait Zippable[-A, -B]

Implementation taken from https://github.com/zio/zio/blob/28a8b2d5cc1e361abc3bb3421bb015b2c063776b/core/shared/src/main/scala/zio/Zippable.scala

Implementation taken from https://github.com/zio/zio/blob/28a8b2d5cc1e361abc3bb3421bb015b2c063776b/core/shared/src/main/scala/zio/Zippable.scala

Companion:
object
object Zippable extends ZippableLowPriority
Companion:
class
trait ZippableLowPriority
sealed trait `__Value`

Value that can be returned by the server or sent as an argument.

Value that can be returned by the server or sent as an argument.

Companion:
object
object `__Value`
Companion:
class