Struct BufResult

pub struct BufResult<T, B>(pub Result<T>, pub B);

A specialized Result type for operations with buffers.

This type is used as a return value for asynchronous compio methods that require passing ownership of a buffer to the runtime. When the operation completes, the buffer is returned no matter if the operation completed successfully.

Tuple Fields

0: Result<T>

1: B

Implementations

impl<T, B> BufResult<T, B>

pub const fn is_ok(&self) -> bool

Returns true if the result is Ok.

pub const fn is_err(&self) -> bool

Returns true if the result is Err.

pub fn map<U>(self, f: impl FnOnce(T, B) -> (U, B)) -> BufResult<U, B>

Maps the result part, and allows updating the buffer.

pub fn map2<U, C>( self, f_ok: impl FnOnce(T, B) -> (U, C), f_err: impl FnOnce(B) -> C, ) -> BufResult<U, C>

Maps the result part, and allows changing the buffer type.

pub fn map_res<U>(self, f: impl FnOnce(T) -> U) -> BufResult<U, B>

Maps the result part, and keeps the buffer unchanged.

pub fn map_buffer<C>(self, f: impl FnOnce(B) -> C) -> BufResult<T, C>

Maps the buffer part, and keeps the result unchanged.

pub fn and_then<U>( self, f: impl FnOnce(T, B) -> (Result<U>, B), ) -> BufResult<U, B>

Updating the result type and modifying the buffer.

pub fn expect(self, msg: &str) -> (T, B)

Returns the contained Ok value, consuming the self value.

pub fn unwrap(self) -> (T, B)

Returns the contained Ok value, consuming the self value.

Trait Implementations

impl<T, B> From<(Result<T, Error>, B)> for BufResult<T, B>

fn from((res, buf): (Result<T>, B)) -> Self

Converts to this type from the input type.

impl<T, B> From<BufResult<T, B>> for (Result<T>, B)

fn from(BufResult: BufResult<T, B>) -> Self

Converts to this type from the input type.

impl<T, B> FromResidual<BufResult<Infallible, B>> for BufResult<T, B>

Available on crate feature try_trait_v2 only.

fn foo() -> BufResult<i32, i32> {
    let (a, b) = BufResult(Ok(1), 2)?;
    assert_eq!(a, 1);
    assert_eq!(b, 2);
    (Ok(3), 4).into()
}
assert!(foo().is_ok());

fn from_residual(residual: BufResult<Infallible, B>) -> Self

🔬This is a nightly-only experimental API. (try_trait_v2)

Constructs the type from a compatible Residual type.

impl<T, B> FromResidual<BufResult<Infallible, B>> for Result<T>

Available on crate feature try_trait_v2 only.

fn foo() -> std::io::Result<i32> {
    let (a, b) = BufResult(Ok(1), 2)?;
    assert_eq!(a, 1);
    assert_eq!(b, 2);
    Ok(3)
}
assert!(foo().is_ok());

fn from_residual(residual: BufResult<Infallible, B>) -> Self

🔬This is a nightly-only experimental API. (try_trait_v2)

Constructs the type from a compatible Residual type.

impl<T: IntoInner, O> IntoInner for BufResult<O, T>

type Inner = BufResult<O, <T as IntoInner>::Inner>

The inner type.

fn into_inner(self) -> Self::Inner

Get the inner buffer.

impl<T, B> Residual<(T, B)> for BufResult<Infallible, B>

Available on crate feature try_trait_v2 only.

type TryType = BufResult<T, B>

🔬This is a nightly-only experimental API. (try_trait_v2_residual)

The “return” type of this meta-function.

impl<T, B> Try for BufResult<T, B>

Available on crate feature try_trait_v2 only.

type Output = (T, B)

🔬This is a nightly-only experimental API. (try_trait_v2)

The type of the value produced by ? when not short-circuiting.

type Residual = BufResult<Infallible, B>

🔬This is a nightly-only experimental API. (try_trait_v2)

The type of the value passed to FromResidual::from_residual as part of ? when short-circuiting.

fn from_output((res, buf): Self::Output) -> Self

🔬This is a nightly-only experimental API. (try_trait_v2)

Constructs the type from its Output type.

fn branch(self) -> ControlFlow<Self::Residual, Self::Output>

🔬This is a nightly-only experimental API. (try_trait_v2)

Used in ? to decide whether the operator should produce a value (because this returned ControlFlow::Continue) or propagate a value back to the caller (because this returned ControlFlow::Break).