stdlibx.result package

exception stdlibx.result.ResultError

Bases: Exception

exception stdlibx.result.ResultExpectError

Bases: ResultError

exception stdlibx.result.ResultUnwrapError

Bases: ResultError

class stdlibx.result.Error(error)

Bases: Generic[T, E]

Parameters:

error (E)

apply(operation)

Parameters:

operation (Operation[Result[T, E], U])

Return type:

U

is_err()

Return type:

Literal[True]

is_ok()

Return type:

Literal[False]

error: E

class stdlibx.result.Ok(value)

Bases: Generic[T, E]

Parameters:

value (T)

apply(operation)

Parameters:

operation (Operation[Result[T, E], U])

Return type:

U

is_err()

Return type:

Literal[False]

is_ok()

Return type:

Literal[True]

value: T

stdlibx.result.as_result(func, exceptions=(<class 'Exception'>, ))

Parameters:

• func (Callable[P, T])

• exceptions (tuple[type[_AnyException], ...])

Return type:

Callable[P, Result[T, _AnyException]]

stdlibx.result.is_err(result)

Parameters:

result (Result[T, E])

Return type:

TypeGuard[Error[T, E]]

stdlibx.result.is_ok(result)

Parameters:

result (Result[T, E])

Return type:

TypeGuard[Ok[T, E]]

stdlibx.result.result_of(func, *args, **kwargs)

Parameters:

• func (Callable[P, T])

• args (P.args)

• kwargs (P.kwargs)

Return type:

Result[T, Exception]

Subpackages

• stdlibx.result.fn package
  • and_()
  • and_then()
  • collect()
  • collect_all()
  • err()
  • expect()
  • expect_err()
  • flatten()
  • inspect()
  • inspect_err()
  • is_err_and()
  • is_ok_and()
  • map_()
  • map_err()
  • map_or()
  • map_or_else()
  • ok()
  • or_()
  • or_else()
  • transpose()
  • unwrap()
  • unwrap_err()
  • unwrap_or()
  • unwrap_or_else()
  • unwrap_or_raise()
  • zipped()
  • Submodules
    • stdlibx.result.fn.base module
      • and_()
      • and_then()
      • expect()
      • expect_err()
      • flatten()
      • inspect()
      • inspect_err()
      • is_err_and()
      • is_ok_and()
      • map_()
      • map_err()
      • map_or()
      • map_or_else()
      • or_()
      • or_else()
      • unwrap()
      • unwrap_err()
      • unwrap_or()
      • unwrap_or_else()
      • unwrap_or_raise()
      • zipped()
    • stdlibx.result.fn.collect module
      • collect()
      • collect_all()
    • stdlibx.result.fn.option module
      • err()
      • ok()
      • transpose()
• stdlibx.result.methods package
  • and_()
  • and_then()
  • err()
  • expect()
  • expect_err()
  • flatten()
  • inspect()
  • inspect_err()
  • is_err_and()
  • is_ok_and()
  • map_()
  • map_err()
  • map_or()
  • map_or_else()
  • ok()
  • or_()
  • or_else()
  • transpose()
  • unwrap()
  • unwrap_err()
  • unwrap_or()
  • unwrap_or_else()
  • unwrap_or_raise()
  • zipped()
  • Submodules
    • stdlibx.result.methods.base module
      • and_()
      • and_then()
      • expect()
      • expect_err()
      • flatten()
      • inspect()
      • inspect_err()
      • is_err_and()
      • is_ok_and()
      • map_()
      • map_err()
      • map_or()
      • map_or_else()
      • or_()
      • or_else()
      • unwrap()
      • unwrap_err()
      • unwrap_or()
      • unwrap_or_else()
      • unwrap_or_raise()
      • zipped()
    • stdlibx.result.methods.option module
      • err()
      • ok()
      • transpose()