Enum ConnectionState 

pub enum ConnectionState<T> {
    Disconnected,
    Connected(T),
}

A backend state that is either disconnected or fully connected.

Buffer implementations use this helper when their reader or writer can be constructed before the peer endpoint exists, then filled in during connection setup.

Variants

Disconnected

No backend has been connected yet.

Connected(T)

The backend is fully connected and ready to use.

Implementations

impl<T> ConnectionState<T>

pub const fn disconnected() -> Self

Create a disconnected backend state.

pub fn is_connected(&self) -> bool

Whether the backend has been connected.

pub fn as_ref(&self) -> Option<&T>

Borrow the connected backend if present.

pub fn as_mut(&mut self) -> Option<&mut T>

Borrow the connected backend mutably if present.

pub fn connected(&self) -> &T

Get the connected backend, panicking if it is still disconnected.

Call this after validate() has proven the buffer is connected.

pub fn connected_mut(&mut self) -> &mut T

Get the connected backend mutably, panicking if it is still disconnected.

Call this after validate() has proven the buffer is connected.

pub fn set_connected(&mut self, value: T)

Replace the state with a connected backend.

pub fn take_connected(&mut self) -> Option<T>

Take the connected backend out of the state.

Trait Implementations

impl<T: Debug> Debug for ConnectionState<T>

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

Formats the value using the given formatter.