GitHub

API reference for Success.

Attributes

AttributeTypeDescription
valueA_co

Functions

__init__

__init__(value) -> None
ParameterTypeDescription
valueA_co

map

map(f) -> Success[B]
ParameterTypeDescription
fCallable[[A_co], B]

Returns Success[B]

def map[B](self, f: Callable[[A_co], B]) -> Success[B]:
    return Success(f(self.value))

map_error

map_error(f) -> Success[A_co]
ParameterTypeDescription
fCallable[[Never], object]

Returns Success[A_co]

def map_error(self, f: Callable[[Never], object]) -> Success[A_co]:
    return self

map_both

map_both(*, on_failure, on_success) -> Success[B]
ParameterTypeDescription
on_failureCallable[[Never], object]
on_successCallable[[A_co], B]

Returns Success[B]

def map_both[B](
    self, *, on_failure: Callable[[Never], object], on_success: Callable[[A_co], B]
) -> Success[B]:
    return Success(on_success(self.value))

as_void

as_void() -> Success[None]

Returns Success[None]

def as_void(self) -> Success[None]:
    return Success(None)

match

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

Returns C

def match[C](
    self, *, on_failure: Callable[[Never], object], on_success: Callable[[A_co], C]
) -> C:
    return on_success(self.value)