GitHub

Middleware

API reference for Middleware.

A function of the whole parse each way: decode(effect, options) gets the source's parse (an effect giving Some(value), or None for a missing value, or failing with its issue) and gives the target's (Effect's Middleware). It sees failures, so it can recover from them (catch_decoding).

Attributes

AttributeTypeDescription
decodeCallable[[_Parse[E, Any], ParseOptions], _Parse[T, RD_co]]
encodeCallable[[_Parse[T, Any], ParseOptions], _Parse[E, RE_co]]
sees_failuresbool

Functions

__init__

__init__(decode, encode) -> None
ParameterTypeDescription
decodeCallable[[_Parse[E, Any], ParseOptions], _Parse[T, RD_co]]
encodeCallable[[_Parse[T, Any], ParseOptions], _Parse[E, RE_co]]

flip

flip() -> Middleware[E, T, RE_co, RD_co]

Returns Middleware[E, T, RE_co, RD_co]

def flip(self) -> Middleware[E, T, RE_co, RD_co]:
    return Middleware(self.encode, self.decode)

pipe

pipe[B](f) -> B
ParameterTypeDescription
fCallable[[Self], B]

Returns B

def pipe[B](self, f: Callable[[Self], B], /) -> B:
    return f(self)

decode_result

decode_result(result, options) -> ParseResult
ParameterTypeDescription
resultParseResult
optionsParseOptions

Returns ParseResult

def decode_result(self, result: ParseResult, options: ParseOptions) -> ParseResult:
    source = cast("_Parse[E, Any]", to_effect(map_value(result, _option)))
    return map_value(call(self.decode, source, options), _value)