Pair

sttp.tapir.EndpointTransput.Pair
sealed trait Pair[T] extends EndpointTransput[T]

Attributes

Graph
Supertypes
trait EndpointTransput[T]
class Object
trait Matchable
class Any
Known subtypes
class Pair[T, U, TU]
class Pair[T, U, TU]
class Pair[T, U, TU]

Members list

Value members

Abstract methods

Concrete methods

override def show: String

Attributes

Definition Classes

Inherited methods

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