Enum carrier_pigeon::net::Status

pub enum Status {
    Connected,
    Disconnected(Box<dyn Any + Send + Sync>),
    Closed,
    Dropped(Error),
}

An enum for the possible states of a connection.

Variants

Connected

The connection is still live.

Disconnected(Box<dyn Any + Send + Sync>)

The connection is closed because the peer disconnected by sending a disconnection message.

Closed

The connection is closed because we chose to close the connection.

Dropped(Error)

The connection was dropped without sending a disconnection message.

Implementations

impl Status

pub fn connected(&self) -> bool

Returns whether the status is Status::Connected.

pub fn disconnected<D: Any + Send + Sync>(&self) -> Option<&D>

Turns this into an option with the disconnect message.

Panics

Panics if the generic parameter D isn’t the disconnect message type (the same D that you passed into MsgTable::build).

pub fn disconnected_dyn(&self) -> Option<&Box<dyn Any + Send + Sync>>

Turns this into an option with the disconnect message.

pub fn dropped(&self) -> Option<&Error>

Turns this into an option with the drop error.

pub fn closed(&self) -> bool

Returns whether the status is Status::Closed.

Trait Implementations

impl Debug for Status

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

Formats the value using the given formatter.

impl Display for Status

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

Formats the value using the given formatter.