Struct yamux::Control

pub struct Control { /* fields omitted */ }

The Yamux Connection controller.

While a Yamux connection makes progress via its next_stream method, this controller can be used to concurrently direct the connection, e.g. to open a new stream to the remote or to close the connection.

The possible operations are implemented as async methods and redundantly as poll-based variants which may be useful inside of other poll based environments such as certain trait implementations.

Methods

impl Control

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

Open a new stream to the remote.

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

Close the connection.

pub fn poll_open_stream(
    self: Pin<&mut Self>,
    cx: &mut Context
) -> Poll<Result<Stream, ConnectionError>>

Poll based alternative to Control::open_stream.

pub fn abort_open_stream(&mut self)

Abort an ongoing open stream operation started by poll_open_stream.

pub fn poll_close(
    self: Pin<&mut Self>,
    cx: &mut Context
) -> Poll<Result<(), ConnectionError>>

Poll based alternative to Control::close.

Trait Implementations

impl Clone for Control

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Control

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

Formats the value using the given formatter.