Struct yamux::Connection

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

A Yamux connection object.

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

Implementations

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

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

pub fn poll_new_outbound( &mut self, cx: &mut Context<'_>, ) -> Poll<Result<Stream>>

Poll for a new outbound stream.

This function will fail if the current state does not allow opening new outbound streams.

pub fn poll_next_inbound( &mut self, cx: &mut Context<'_>, ) -> Poll<Option<Result<Stream>>>

Poll for the next inbound stream.

If this function returns None, the underlying connection is closed.

pub fn poll_close(&mut self, cx: &mut Context<'_>) -> Poll<Result<()>>

Close the connection.

Trait Implementations

impl<T: Debug> Debug 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.