Enum ratchet_rs::CloseCause

pub enum CloseCause {
    Stopped,
    Error,
}

The channel is closed

Variants

Stopped

The channel closed nominally. This is not an error and instead indicates a clean closure of the channel by either ourselves or the peer.

Error

This is only produced when a user attempts to reuse a closed channel and instead indicates a bug in your code.

Trait Implementations

impl Clone for CloseCause

fn clone(&self) -> CloseCause

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CloseCause

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

Formats the value using the given formatter.

impl Display for CloseCause

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

Formats the value using the given formatter.

impl Error for CloseCause

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

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 self, req: &mut Demand<'a>)

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

Provides type based access to context intended for error reports.

impl PartialEq<CloseCause> for CloseCause

fn eq(&self, other: &CloseCause) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Copy for CloseCause

impl StructuralPartialEq for CloseCause