tapir-core
API
Generated with
tapir-core/sttp.tapir/EndpointIO

EndpointIO

sttp.tapir.EndpointIO
See theEndpointIO companion object
sealed trait EndpointIO[T] extends EndpointInput[T], EndpointOutput[T]

Attributes

Companion
object
Graph
Supertypes
trait EndpointOutput[T]
trait EndpointInput[T]
trait EndpointTransput[T]
class Object
trait Matchable
class Any
Show all
Known subtypes
class Pair[T, U, TU]
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]
Show all

Members list

Value members

Concrete methods

def and[J, IJ](other: EndpointIO[J])(implicit concat: Aux[T, J, IJ]): EndpointIO[IJ]

Inherited methods

def /[U, TU](other: EndpointInput[U])(implicit concat: Aux[T, U, TU]): EndpointInput[TU]

Attributes

Inherited from:
EndpointInput
def and[J, IJ](other: EndpointOutput[J])(implicit concat: Aux[T, J, IJ]): EndpointOutput[IJ]

Attributes

Inherited from:
EndpointOutput
def and[U, TU](other: EndpointInput[U])(implicit concat: Aux[T, U, TU]): EndpointInput[TU]

Attributes

Inherited from:
EndpointInput
def map[U](f: T => U)(g: U => T): ThisType[U]

Attributes

Inherited from:
EndpointTransput
def mapDecode[U](f: T => DecodeResult[U])(g: U => T): ThisType[U]

Attributes

Inherited from:
EndpointTransput
inline def mapTo[CASE_CLASS <: Product](using mc: ProductOf[CASE_CLASS]): ThisType[CASE_CLASS]

Attributes

Inherited from:
EndpointTransputMacros
def mapValidate[U](v: Validator[T])(f: T => U)(g: U => T): ThisType[U]

Adds the given validator, and maps to the given higher-level type U.

Adds the given validator, and maps to the given higher-level type U.

Unlike a .validate(v).map(f)(g) invocation, during decoding the validator is run before applying the f function. If there are validation errors, decoding fails. However, the validator is then invoked again on the fully decoded value.

This is useful to create inputs/outputs for types, which are unrepresentable unless the validator's condition is met, e.g. due to preconditions in the constructor.

Attributes

See also
Inherited from:
EndpointTransput
def validate(v: Validator[T]): ThisType[T]

Adds a validator.

Adds a validator.

Note that validation is run on a fully decoded value. That is, during decoding, first the decoding functions are run, followed by validations. Hence any functions provided in subsequent .map s or .mapDecode s will be invoked before validation.

Attributes

See also
Inherited from:
EndpointTransput

Inherited and Abstract methods

def map[U](mapping: Mapping[T, U]): ThisType[U]

Attributes

Inherited from:
EndpointTransput
def show: String

Attributes

Inherited from:
EndpointTransput
Generated with