GitHub

API reference for Failure.

Attributes

AttributeTypeDescription
causeCause[E_co]

Functions

__init__

__init__(cause) -> None
ParameterTypeDescription
causeCause[E_co]

map

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

Returns Failure[E_co]

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

map_error

map_error(f) -> Failure[E2]

Map the typed errors; defects and interruptions stay.

ParameterTypeDescription
fCallable[[E_co], E2]

Returns Failure[E2]

def map_error[E2](self, f: Callable[[E_co], E2]) -> Failure[E2]:
    """Map the typed errors; defects and interruptions stay."""
    return Failure(self.cause.map(f))

map_both

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

Returns Failure[E2]

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

as_void

as_void() -> Failure[E_co]

Returns Failure[E_co]

def as_void(self) -> Failure[E_co]:
    return self

match

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

Returns B

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