GitHub

API reference for Ok.

Attributes

AttributeTypeDescription
valueA_co

Functions

__init__

__init__(value) -> None
ParameterTypeDescription
valueA_co

map

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

Returns Ok[B]

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

map_error

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

Returns Ok[A_co]

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

map_both

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

Returns Ok[B]

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

flat_map

flat_map(f) -> Result[B, E2]
ParameterTypeDescription
fCallable[[A_co], Result[B, E2]]

Returns Result[B, E2]

def flat_map[B = Never, E2 = Never](self, f: Callable[[A_co], Result[B, E2]]) -> Result[B, E2]:
    return f(self.value)

get_or_else

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

Returns A_co

def get_or_else(self, f: Callable[[Never], object]) -> A_co:
    return self.value

get_or_raise

get_or_raise() -> A_co

Returns A_co

def get_or_raise(self) -> A_co:
    return self.value

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)