Struct yamux::Connection

pub struct Connection<T> { /* fields omitted */ }

A Yamux connection object.

Wraps the underlying I/O resource and makes progress via its Connection::next_stream method which must be called repeatedly until Ok(None) signals EOF or an error is encountered.

Methods

impl<T: AsyncRead + AsyncWrite + Unpin> Connection<T>

pub fn new(socket: T, cfg: Config, mode: Mode) -> Self

Create a new Connection from the given I/O resource.

pub fn control(&self) -> Control

Get a controller for this connection.

pub async fn next_stream<'_>(
    &'_ mut self
) -> Result<Option<Stream>, ConnectionError>

Get the next incoming stream, opened by the remote.

This must be called repeatedly in order to make progress. Once Ok(None) or Err(_) is returned the connection is considered closed and no further invocation of this method must be attempted.

Cancellation

Please note that if you poll the returned Future it must not be cancelled but polled until Poll::Ready is returned.

Trait Implementations

impl<T> Debug for Connection<T>

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

Formats the value using the given formatter.

impl<T> Display for Connection<T>

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

Formats the value using the given formatter.

impl<T> Drop for Connection<T>

fn drop(&mut self)

Executes the destructor for this type.