MappedPair

sttp.tapir.EndpointOutput.MappedPair
case class MappedPair[T, U, TU, V](output: Pair[T, U, TU], mapping: Mapping[TU, V]) extends Single[V]

Attributes

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

Members list

Value members

Concrete methods

override def map[W](m: Mapping[V, W]): MappedPair[T, U, TU, W]

Attributes

Definition Classes
override def show: String

Attributes

Definition Classes

Inherited methods

def and[J, IJ](other: EndpointOutput[J])(implicit concat: Aux[V, J, IJ]): EndpointOutput[IJ]

Attributes

Inherited from:
EndpointOutput
def map[U](f: V => U)(g: U => V): ThisType[U]

Attributes

Inherited from:
EndpointTransput
def mapDecode[U](f: V => DecodeResult[U])(g: U => V): 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[V])(f: V => U)(g: U => V): 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 productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
def validate(v: Validator[V]): ThisType[V]

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