Enum SessionIncomplete

pub enum SessionIncomplete<Tx, Rx> {
    BothHalves {
        tx: IncompleteHalf<Tx>,
        rx: IncompleteHalf<Rx>,
    },
    TxHalf {
        tx: IncompleteHalf<Tx>,
        rx: Rx,
    },
    RxHalf {
        tx: Tx,
        rx: IncompleteHalf<Rx>,
    },
}

The error returned when a closure which is expected to complete a channel’s session fails to finish the session of the channel it is given.

This error can arise either if the channel is dropped before its session is completed, or if it is stored somewhere and is dropped after the closure’s future is finished. The best way to ensure this error does not occur is to call close on the channel, which statically ensures it is dropped exactly when the session is complete.

Variants

BothHalves

Both the sending half Tx and the receiving half Rx did not complete the session correctly.

Fields

tx: IncompleteHalf<Tx>

The incomplete sending half: Unfinished if dropped before the end of the session, Unclosed if not dropped after the end of the session.

rx: IncompleteHalf<Rx>

The incomplete receiving half: Unfinished if dropped before the end of the session, Unclosed if not dropped after the end of the session.

TxHalf

Only the sending half Tx did not complete the session correctly, but the receiving half Rx did complete it correctly.

Fields

tx: IncompleteHalf<Tx>

The incomplete sending half: Unfinished if dropped before the end of the session, Unclosed if not dropped after the end of the session.

rx: Rx

The receiving half, whose session was completed.

RxHalf

Only the receiving half Rx did not complete the session correctly, but the sending half Tx did complete it correctly.

Fields

tx: Tx

The sending half, whose session was completed.

rx: IncompleteHalf<Rx>

The incomplete receiving half: Unfinished if dropped before the end of the session, Unclosed if not dropped after the end of the session.

Implementations

impl<Tx, Rx> SessionIncomplete<Tx, Rx>

pub fn into_halves( self, ) -> (Result<Tx, IncompleteHalf<Tx>>, Result<Rx, IncompleteHalf<Rx>>)

Extract the send and receive halves Tx and Rx, if they are present, from this SessionIncomplete error.

Trait Implementations

impl<Tx, Rx> Debug for SessionIncomplete<Tx, Rx>

fn fmt(&self, __f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<Tx, Rx> Display for SessionIncomplete<Tx, Rx>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<Tx, Rx> Error for SessionIncomplete<Tx, Rx>

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type-based access to context intended for error reports.