StreamBodyIO

Add an example of a "deserialized" stream value. This should be given in an encoded form, e.g. in case of json - as a String, as the stream body doesn't have access to the codec that will be later used for deserialization.

Lift this streaming body into an EndpointIO, so that it can be used as a regular endpoint input/output, "forgetting" the streaming requirement. This is useful when using the streaming body in Tapir.oneOf or Tapir.oneOfBody, however at the expense of type safety: the fact that the endpoint can only be interpreted by an interpreter supporting the given stream type is lost; in case of a mismatch, a run-time error will occur.

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.

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 .maps or .mapDecodes will be invoked before validation.

Adds a validator which validates each element in the collection.

Should only be used if the schema hasn't been created by .mapping another one, but directly from Schema[U]. Otherwise the shape of the schema doesn't correspond to the type T, but to some lower-level representation of the type. This might cause invalid results at run-time.

Adds a validator which validates the option's element, if it is present.

Should only be used if the schema hasn't been created by .mapping another one, but directly from Schema[U]. Otherwise the shape of the schema doesn't correspond to the type T, but to some lower-level representation of the type. This might cause invalid results at run-time.