tests
API
Generated with
tests/smithy4s/smithy4s.example/PizzaAdminServiceGen

PizzaAdminServiceGen

smithy4s.example.PizzaAdminServiceGen
See thePizzaAdminServiceGen companion trait
object PizzaAdminServiceGen extends Mixin[[F[_, _, _, _, _]] =>> PizzaAdminServiceGen[F], PizzaAdminServiceOperation]

Attributes

Companion
trait
Graph
Supertypes
trait Mixin[[F[_, _, _, _, _]] =>> PizzaAdminServiceGen[F], PizzaAdminServiceOperation]
trait Service[[F[_, _, _, _, _]] =>> PizzaAdminServiceGen[F]]
trait HasId
trait FunctorK5[[F[_, _, _, _, _]] =>> PizzaAdminServiceGen[F]]
class Object
trait Matchable
class Any
Show all
Self type

Members list

Type members

Classlikes

class Constant[P[_, _, _, _, _]](value: P[Any, Nothing, Nothing, Nothing, Nothing]) extends Transformed[PizzaAdminServiceOperation, P]

Attributes

Supertypes
class Object
trait Matchable
class Any
object ErrorAware

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
ErrorAware.type

Types

type Default[F[_]] = Constant[<none>]

Inherited types

type BiFunctorEndpointCompiler[F[_, _]] = EndpointCompiler[<none>]

A EndpointCompiler specialised for effects of kind * -> (*, *), like Either or bifunctor IO

A EndpointCompiler specialised for effects of kind * -> (*, *), like Either or bifunctor IO

Attributes

Inherited from:
Service
type BiFunctorInterpreter[F[_, _]] = Interpreter[<none>]

An interpreter specialised for effects of kind * -> (*, *), like Either or bifunctor IO.

An interpreter specialised for effects of kind * -> (*, *), like Either or bifunctor IO.

Attributes

Inherited from:
Service
type Endpoint[I, E, O, SI, SO] = Endpoint[Operation, I, E, O, SI, SO]

An endpoint is the set of schemas tied to types associated with an Operation. It has a method to wrap the input in an operation instance I => Operation[I, E, O, SI, SO].

An endpoint is the set of schemas tied to types associated with an Operation. It has a method to wrap the input in an operation instance I => Operation[I, E, O, SI, SO].

You can think of the endpoint as a "template for an Operation". It contains everything needed to decode/encode operation calls to/from low-level representations (like http requests).

Attributes

Inherited from:
Service
type EndpointCompiler[F[_, _, _, _, _]] = PolyFunction5[Endpoint, <none>]

A polymorphic function that can take an Endpoint (associated to this service) and produces an handler for it, namely a function that takes the input type of the operation, and produces an effect.

A polymorphic function that can take an Endpoint (associated to this service) and produces an handler for it, namely a function that takes the input type of the operation, and produces an effect.

Attributes

Inherited from:
Service
type ErrorAware[F[_, _]] = BiFunctorAlgebra[Alg, F]

A short-hand for algebras that are specialised for effects of kind * -> (*, *). This is meant to be used in userland, e.g:

A short-hand for algebras that are specialised for effects of kind * -> (*, *). This is meant to be used in userland, e.g:

 val myService = MyService.ErrorAware[Either]

Attributes

Inherited from:
Service
type FunctorEndpointCompiler[F[_]] = EndpointCompiler[<none>]

A EndpointCompiler specialised for effects of kind * -> *, like Try or monofunctor IO

A EndpointCompiler specialised for effects of kind * -> *, like Try or monofunctor IO

Attributes

Inherited from:
Service
type FunctorInterpreter[F[_]] = Interpreter[<none>]

An interpreter specialised for effects of kind * -> *, like Try or monofunctor IO.

An interpreter specialised for effects of kind * -> *, like Try or monofunctor IO.

Attributes

Inherited from:
Service
type Impl[F[_]] = FunctorAlgebra[Alg, F]

A short-hand for algebras that are specialised for effects of kind * -> *.

A short-hand for algebras that are specialised for effects of kind * -> *.

NB: this alias should be used in polymorphic implementations. When using the Smithy4s code generator, equivalent aliases that are named after the service are generated (e.g. Weather corresponding to WeatherGen).

Attributes

Inherited from:
Service
type Interpreter[F[_, _, _, _, _]] = PolyFunction5[Operation, F]

This is a polymorphic function that runs an instance of an operation and produces an effect F.

This is a polymorphic function that runs an instance of an operation and produces an effect F.

Attributes

Inherited from:
Service
type Operation[I, E, O, SI, SO] = Op[I, E, O, SI, SO]

A datatype (typically a sealed trait) that reifies an operation call within a service. It essentially captures the input and type indexes that the operation deals with. It also typically captures an input value.

A datatype (typically a sealed trait) that reifies an operation call within a service. It essentially captures the input and type indexes that the operation deals with. It also typically captures an input value.

It is possible to think of Operation as an "applied Endpoint", or a "call to an Endpoint".

Type parameters

E:

the error type associated to the operation (typically represented as a sealed-trait)

I:

the input of the operation

O:

the output of the operation

SI:

the streamed input of an operation. Operations can have unary components and streamed components. For instance, an http call can send headers (unary I) and a stream of bytes (streamed SI) to the server.

SO:

the streamed output of the operation.

Attributes

Inherited from:
Mixin

Value members

Concrete methods

def apply[F[_]](implicit F: Impl[F]): Impl[F]
override def endpoint[I, E, O, SI, SO](op: PizzaAdminServiceOperation[I, E, O, SI, SO]): Endpoint[I, E, O, SI, SO]

Attributes

Definition Classes
Service
def fromPolyFunction[P[_, _, _, _, _]](f: PolyFunction5[PizzaAdminServiceOperation, P]): PizzaAdminServiceGen[P]
def input[I, E, O, SI, SO](op: PizzaAdminServiceOperation[I, E, O, SI, SO]): I
def mapK5[P[_, _, _, _, _], P1[_, _, _, _, _]](alg: PizzaAdminServiceGen[P], f: PolyFunction5[P, P1]): PizzaAdminServiceGen[P1]
def ordinal[I, E, O, SI, SO](op: PizzaAdminServiceOperation[I, E, O, SI, SO]): Int
def toPolyFunction[P[_, _, _, _, _]](impl: PizzaAdminServiceGen[P]): PolyFunction5[PizzaAdminServiceOperation, P]

Inherited methods

final def algebra[F[_, _, _, _, _]](compiler: EndpointCompiler[F]): Alg[F]

A function that takes an endpoint compiler and produces an Algebra (typically an instance of the generated interfaces), backed by an interpreter.

A function that takes an endpoint compiler and produces an Algebra (typically an instance of the generated interfaces), backed by an interpreter.

This is useful for writing generic functions that result in the instantiation of a client instance that abides by the service interface.

Attributes

Inherited from:
Service
final def bifunctorInterpreter[F[_, _]](compiler: BiFunctorEndpointCompiler[F]): BiFunctorInterpreter[F]

A bifunctor-specialised version of interpreter

A bifunctor-specialised version of interpreter

Attributes

Inherited from:
Service
final def errorAware[F[_, _]](compiler: BiFunctorEndpointCompiler[F]): ErrorAware[F]

A monofunctor-specialised version of algebra

A monofunctor-specialised version of algebra

Attributes

Inherited from:
Service
final def functorInterpreter[F[_]](compiler: FunctorEndpointCompiler[F]): FunctorInterpreter[F]

A monofunctor-specialised version of interpreter

A monofunctor-specialised version of interpreter

Attributes

Inherited from:
Service
final def impl[F[_]](compiler: FunctorEndpointCompiler[F]): Impl[F]

A monofunctor-specialised version of algebra

A monofunctor-specialised version of algebra

Attributes

Inherited from:
Service
final def interpreter[F[_, _, _, _, _]](compiler: EndpointCompiler[F]): Interpreter[F]

Given a generic way to turn an endpoint into some handling function (like I => F[I, E, O, SI, SO]), this method takes care of the logic necessary to produce an interpreter that takes an Operation associated to the service and routes it to the correct function, returning the result.

Given a generic way to turn an endpoint into some handling function (like I => F[I, E, O, SI, SO]), this method takes care of the logic necessary to produce an interpreter that takes an Operation associated to the service and routes it to the correct function, returning the result.

Attributes

Inherited from:
Service

Concrete fields

val endpoints: Vector[Endpoint[PizzaAdminServiceOperation, _, _, _, _, _]]
val hints: Hints
val id: ShapeId

Inherited fields

final val opToEndpoint: PolyFunction5[Operation, Endpoint]

Attributes

Inherited from:
Service
val service: Service[[F[_, _, _, _, _]] =>> PizzaAdminServiceGen[F]]

Attributes

Inherited from:
Service

Implicits

Inherited implicits

implicit val serviceInstance: Service[[F[_, _, _, _, _]] =>> PizzaAdminServiceGen[F]]

Attributes

Inherited from:
Mixin
Generated with