object EndpointOutput extends EndpointOutputMacros
- Alphabetic
- By Inheritance
- EndpointOutput
- EndpointOutputMacros
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- sealed trait Atom[T] extends Basic[T] with EndpointTransput.Atom[T]
- sealed trait Basic[T] extends Single[T] with EndpointTransput.Basic[T]
- case class FixedStatusCode[T](statusCode: model.StatusCode, codec: Codec[Unit, T, TextPlain], info: Info[T]) extends Atom[T] with Product with Serializable
- case class MappedPair[T, U, TU, V](output: Pair[T, U, TU], mapping: Mapping[TU, V]) extends Single[V] with Product with Serializable
- case class OneOf[O, T](variants: List[OneOfVariant[_ <: O]], mapping: Mapping[O, T]) extends Single[T] with Product with Serializable
- case class OneOfVariant[O] extends Product with Serializable
Specifies one possible
output
.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) returnstrue
.- 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 typeO
. This check cannot be in general done by checking the run-time class of the value, due to type erasure (ifO
has type parameters). - case class Pair[T, U, TU](left: EndpointOutput[T], right: EndpointOutput[U], combine: CombineParams, split: SplitParams) extends EndpointOutput[TU] with EndpointTransput.Pair[TU] with Product with Serializable
- sealed trait Single[T] extends EndpointOutput[T]
- case class StatusCode[T](documentedCodes: Map[Either[model.StatusCode, StatusCodeRange], Info[Unit]], codec: Codec[model.StatusCode, T, TextPlain], info: Info[T]) extends Atom[T] with Product with Serializable
- case class Void[T]() extends EndpointOutput[T] with Product with Serializable
- case class WebSocketBodyWrapper[PIPE_REQ_RESP, T](wrapped: WebSocketBodyOutput[PIPE_REQ_RESP, _, _, T, _]) extends Atom[T] with Product with Serializable
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- macro def derived[T]: EndpointOutput[T]
Derives an output description using metadata specified with annotations on the given case class.
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.
- Definition Classes
- EndpointOutputMacros
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated