Struct libp2p::core::muxing::SubstreamBox

pub struct SubstreamBox(_);

Abstract type for asynchronous reading and writing.

A SubstreamBox erases the concrete type it is given and only retains its AsyncRead and AsyncWrite capabilities.

Implementations

impl SubstreamBox

pub fn new<S>(stream: S) -> SubstreamBoxwhere
    S: 'static + AsyncRead + AsyncWrite + Send + Unpin,

Construct a new SubstreamBox from something that implements AsyncRead and AsyncWrite.

Trait Implementations

impl AsyncRead for SubstreamBox

fn poll_read(
    self: Pin<&mut SubstreamBox>,
    cx: &mut Context<'_>,
    buf: &mut [u8]
) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into buf.

fn poll_read_vectored(
    self: Pin<&mut SubstreamBox>,
    cx: &mut Context<'_>,
    bufs: &mut [IoSliceMut<'_>]
) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into bufs using vectored IO operations.

impl AsyncWrite for SubstreamBox

fn poll_write(
    self: Pin<&mut SubstreamBox>,
    cx: &mut Context<'_>,
    buf: &[u8]
) -> Poll<Result<usize, Error>>

Attempt to write bytes from buf into the object.

fn poll_write_vectored(
    self: Pin<&mut SubstreamBox>,
    cx: &mut Context<'_>,
    bufs: &[IoSlice<'_>]
) -> Poll<Result<usize, Error>>

Attempt to write bytes from bufs into the object using vectored IO operations.

fn poll_flush(
    self: Pin<&mut SubstreamBox>,
    cx: &mut Context<'_>
) -> Poll<Result<(), Error>>

Attempt to flush the object, ensuring that any buffered data reach their destination.

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

Attempt to close the object.

impl Debug for SubstreamBox

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

Formats the value using the given formatter.