Generated with

EndpointOutput

sttp.tapir.EndpointOutput$

See theEndpointOutput companion trait

object EndpointOutput extends EndpointOutputMacros

Attributes

Companion:: trait
Graph
Supertypes: trait Sum
trait Mirror
trait EndpointOutputMacros
class Object
trait Matchable
class Any
Self type: EndpointOutput.type

Members list

Concise view

Type members

Classlikes

Attributes

Graph
Supertypes: trait Atom[T]
trait Basic[T]
trait Basic[T]
trait Single[T]
trait EndpointOutput[T]
trait EndpointTransput[T]
trait EndpointTransputMacros[T]
class Object
trait Matchable
class Any
Known subtypes: trait Atom[I]
class Body[R, T]
class Empty[T]
class FixedHeader[T]
class Header[T]
class Headers[T]
class StreamBodyWrapper[BS, T]
class FixedStatusCode[T]
class StatusCode[T]
class WebSocketBodyWrapper[PIPE_REQ_RESP, T]

Attributes

Graph
Supertypes: trait Basic[T]
trait Single[T]
trait EndpointOutput[T]
trait EndpointTransput[T]
trait EndpointTransputMacros[T]
class Object
trait Matchable
class Any
Known subtypes: trait Basic[I]
trait Atom[I]
class Body[R, T]
class Empty[T]
class FixedHeader[T]
class Header[T]
class Headers[T]
class StreamBodyWrapper[BS, T]
class OneOfBody[O, T]
trait Atom[T]
class FixedStatusCode[T]
class StatusCode[T]
class WebSocketBodyWrapper[PIPE_REQ_RESP, T]

Attributes

Graph
Supertypes: trait Serializable
trait Product
trait Equals
trait Atom[T]
trait Atom[T]
trait Basic[T]
trait Basic[T]
trait Single[T]
trait EndpointOutput[T]
trait EndpointTransput[T]
trait EndpointTransputMacros[T]
class Object
trait Matchable
class Any

Attributes

Graph
Supertypes: trait Serializable
trait Product
trait Equals
trait Single[V]
trait EndpointOutput[V]
trait EndpointTransput[V]
trait EndpointTransputMacros[V]
class Object
trait Matchable
class Any

Attributes

Graph
Supertypes: trait Serializable
trait Product
trait Equals
trait Single[T]
trait EndpointOutput[T]
trait EndpointTransput[T]
trait EndpointTransputMacros[T]
class Object
trait Matchable
class Any

Specifies one possible output.

When encoding to a response, this output is used if:

appliesTo applied to the output value (as returned by the server logic) returns true.
when a fixed content type specified by the output matches the request's Accept header

When decoding from a response, this output is used if it decodes successfully.

The appliesTo function should determine, whether a runtime value matches the type O. This check cannot be in general done by checking the run-time class of the value, due to type erasure (if O has type parameters).

Attributes

Graph
Supertypes: trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Attributes

Graph
Supertypes: trait Serializable
trait Product
trait Equals
trait Pair[TU]
trait EndpointOutput[TU]
trait EndpointTransput[TU]
trait EndpointTransputMacros[TU]
class Object
trait Matchable
class Any

Attributes

Graph
Supertypes: trait EndpointOutput[T]
trait EndpointTransput[T]
trait EndpointTransputMacros[T]
class Object
trait Matchable
class Any
Known subtypes: trait Single[I]
trait Basic[I]
trait Atom[I]
class Body[R, T]
class Empty[T]
class FixedHeader[T]
class Header[T]
class Headers[T]
class StreamBodyWrapper[BS, T]
class OneOfBody[O, T]
class MappedPair[T, U, TU, V]
trait Basic[T]
trait Atom[T]
class FixedStatusCode[T]
class StatusCode[T]
class WebSocketBodyWrapper[PIPE_REQ_RESP, T]
class MappedPair[T, U, TU, V]
class OneOf[O, T]

Attributes

Graph
Supertypes: trait Serializable
trait Product
trait Equals
trait Atom[T]
trait Atom[T]
trait Basic[T]
trait Basic[T]
trait Single[T]
trait EndpointOutput[T]
trait EndpointTransput[T]
trait EndpointTransputMacros[T]
class Object
trait Matchable
class Any

Attributes

Graph
Supertypes: trait Serializable
trait Product
trait Equals
trait EndpointOutput[T]
trait EndpointTransput[T]
trait EndpointTransputMacros[T]
class Object
trait Matchable
class Any

Attributes

Graph
Supertypes: trait Serializable
trait Product
trait Equals
trait Atom[T]
trait Atom[T]
trait Basic[T]
trait Basic[T]
trait Single[T]
trait EndpointOutput[T]
trait EndpointTransput[T]
trait EndpointTransputMacros[T]
class Object
trait Matchable
class Any

Inherited types

The names of the product elements

Attributes

Inherited from:: Mirror

The name of the type

Attributes

Inherited from:: Mirror

Value members

Inherited methods

Derives an output description using metadata specified with annotations on the given case class. Each field of the case class must be annotated with one of the annotations from sttp.tapir.EndpointIO.annotations. Additional schema meta-data can be specified using annotations from sttp.tapir.Schema.annotations. The result is mapped to an instance of the T type.

Attributes

Inherited from:: EndpointOutputMacros

Generated with