GitHub

API reference for Err.

Attributes

AttributeTypeDescription
errorE_co

Functions

__init__

__init__(error) -> None
ParameterTypeDescription
errorE_co

map

map(f) -> Err[E_co]
ParameterTypeDescription
fCallable[[Never], object]

Returns Err[E_co]

def map(self, f: Callable[[Never], object]) -> Err[E_co]:
    return self

map_error

map_error(f) -> Err[E2]
ParameterTypeDescription
fCallable[[E_co], E2]

Returns Err[E2]

def map_error[E2](self, f: Callable[[E_co], E2]) -> Err[E2]:
    return Err(f(self.error))

map_both

map_both(*, on_failure, on_success) -> Err[E2]
ParameterTypeDescription
on_failureCallable[[E_co], E2]
on_successCallable[[Never], object]

Returns Err[E2]

def map_both[E2](
    self, *, on_failure: Callable[[E_co], E2], on_success: Callable[[Never], object]
) -> Err[E2]:
    return Err(on_failure(self.error))

flat_map

flat_map(f) -> Err[E_co]
ParameterTypeDescription
fCallable[[Never], object]

Returns Err[E_co]

def flat_map(self, f: Callable[[Never], object]) -> Err[E_co]:
    return self

get_or_else

get_or_else(f) -> B
ParameterTypeDescription
fCallable[[E_co], B]

Returns B

def get_or_else[B](self, f: Callable[[E_co], B]) -> B:
    return f(self.error)

get_or_raise

get_or_raise() -> Never

Raise the error. Only an Err holding an exception has this; for other errors, match or get_or_else.

Returns Never

def get_or_raise[X: BaseException](self: Err[X]) -> Never:
    """Raise the error. Only an ``Err`` holding an exception has this;
    for other errors, ``match`` or ``get_or_else``."""
    raise self.error

match

match(*, on_failure, on_success) -> B
ParameterTypeDescription
on_failureCallable[[E_co], B]
on_successCallable[[Never], object]

Returns B

def match[B](
    self, *, on_failure: Callable[[E_co], B], on_success: Callable[[Never], object]
) -> B:
    return on_failure(self.error)