Struct libp2p_core::muxing::SubstreamBox

source · [−]

pub struct SubstreamBox(_);

Expand description

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

source

impl SubstreamBox

source

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

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

Trait Implementations

source

impl AsyncRead for SubstreamBox

source

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

Attempt to read from the AsyncRead into buf. Read more

source

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

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

source

impl AsyncWrite for SubstreamBox

source

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

Attempt to write bytes from buf into the object. Read more

source

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

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

source

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

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

source

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

Attempt to close the object. Read more

source

impl Debug for SubstreamBox

source

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl !RefUnwindSafe for SubstreamBox

impl Send for SubstreamBox

impl !Sync for SubstreamBox

impl Unpin for SubstreamBox

impl !UnwindSafe for SubstreamBox

Blanket Implementations

source

impl<T> Any for Twhere
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<R> AsyncReadExt for Rwhere
R: AsyncRead + ?Sized,

fn chain<R>(self, next: R) -> Chain<Self, R>where
R: AsyncRead,

Creates an adaptor which will chain this stream with another. Read more

fn read(&'a mut self, buf: &'a mut [u8]) -> Read<'a, Self>where
Self: Unpin,

Tries to read some bytes directly into the given buf in asynchronous manner, returning a future type. Read more

fn read_vectored(
 &'a mut self,
 bufs: &'a mut [IoSliceMut<'a>]
) -> ReadVectored<'a, Self>where
 Self: Unpin,

Creates a future which will read from the AsyncRead into bufs using vectored IO operations. Read more

fn read_exact(&'a mut self, buf: &'a mut [u8]) -> ReadExact<'a, Self>where
Self: Unpin,

Creates a future which will read exactly enough bytes to fill buf, returning an error if end of file (EOF) is hit sooner. Read more

fn read_to_end(&'a mut self, buf: &'a mut Vec<u8, Global>) -> ReadToEnd<'a, Self>where
Self: Unpin,

Creates a future which will read all the bytes from this AsyncRead. Read more

fn read_to_string(&'a mut self, buf: &'a mut String) -> ReadToString<'a, Self>where
Self: Unpin,

Creates a future which will read all the bytes from this AsyncRead. Read more

fn split(self) -> (ReadHalf<Self>, WriteHalf<Self>)where
Self: AsyncWrite,

Helper method for splitting this read/write object into two halves. Read more

fn take(self, limit: u64) -> Take<Self>

Creates an AsyncRead adapter which will read at most limit bytes from the underlying reader. Read more

impl<W> AsyncWriteExt for Wwhere
W: AsyncWrite + ?Sized,

fn flush(&mut self) -> Flush<'_, Self>where
Self: Unpin,

Creates a future which will entirely flush this AsyncWrite. Read more

fn close(&mut self) -> Close<'_, Self>where
Self: Unpin,

Creates a future which will entirely close this AsyncWrite.

fn write(&'a mut self, buf: &'a [u8]) -> Write<'a, Self>where
Self: Unpin,

Creates a future which will write bytes from buf into the object. Read more

fn write_vectored(
 &'a mut self,
 bufs: &'a [IoSlice<'a>]
) -> WriteVectored<'a, Self>where
 Self: Unpin,

Creates a future which will write bytes from bufs into the object using vectored IO operations. Read more

fn write_all(&'a mut self, buf: &'a [u8]) -> WriteAll<'a, Self>where
Self: Unpin,

Write data into this object. Read more

fn into_sink<Item>(self) -> IntoSink<Self, Item>where
Item: AsRef<[u8]>,

Allow using an [AsyncWrite] as a Sink<Item: AsRef<[u8]>>. Read more

source

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for Twhere
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T, U> TryFrom for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct libp2p_core::muxing::SubstreamBox

Implementations

impl SubstreamBox

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

Trait Implementations

impl AsyncRead for SubstreamBox

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

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

impl AsyncWrite for SubstreamBox

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

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

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

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

impl Debug for SubstreamBox

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

Auto Trait Implementations

impl !RefUnwindSafe for SubstreamBox

impl Send for SubstreamBox

impl !Sync for SubstreamBox

impl Unpin for SubstreamBox

impl !UnwindSafe for SubstreamBox

Blanket Implementations

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<R> AsyncReadExt for Rwhere R: AsyncRead + ?Sized,

fn chain<R>(self, next: R) -> Chain<Self, R>where R: AsyncRead,

fn read(&'a mut self, buf: &'a mut [u8]) -> Read<'a, Self>where Self: Unpin,

fn read_vectored( &'a mut self, bufs: &'a mut [IoSliceMut<'a>]) -> ReadVectored<'a, Self>where Self: Unpin,

fn read_exact(&'a mut self, buf: &'a mut [u8]) -> ReadExact<'a, Self>where Self: Unpin,

fn read_to_end(&'a mut self, buf: &'a mut Vec<u8, Global>) -> ReadToEnd<'a, Self>where Self: Unpin,

fn read_to_string(&'a mut self, buf: &'a mut String) -> ReadToString<'a, Self>where Self: Unpin,

fn split(self) -> (ReadHalf<Self>, WriteHalf<Self>)where Self: AsyncWrite,

fn take(self, limit: u64) -> Take<Self>

impl<W> AsyncWriteExt for Wwhere W: AsyncWrite + ?Sized,

fn flush(&mut self) -> Flush<'_, Self>where Self: Unpin,

fn close(&mut self) -> Close<'_, Self>where Self: Unpin,

fn write(&'a mut self, buf: &'a [u8]) -> Write<'a, Self>where Self: Unpin,

fn write_vectored( &'a mut self, bufs: &'a [IoSlice<'a>]) -> WriteVectored<'a, Self>where Self: Unpin,

fn write_all(&'a mut self, buf: &'a [u8]) -> WriteAll<'a, Self>where Self: Unpin,

fn into_sink<Item>(self) -> IntoSink<Self, Item>where Item: AsRef<[u8]>,

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

fn vzip(self) -> V

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

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

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

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

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<R> AsyncReadExt for Rwhere
R: AsyncRead + ?Sized,

fn chain<R>(self, next: R) -> Chain<Self, R>where
R: AsyncRead,

fn read(&'a mut self, buf: &'a mut [u8]) -> Read<'a, Self>where
Self: Unpin,

fn read_vectored(
&'a mut self,
bufs: &'a mut [IoSliceMut<'a>]
) -> ReadVectored<'a, Self>where
Self: Unpin,

fn read_exact(&'a mut self, buf: &'a mut [u8]) -> ReadExact<'a, Self>where
Self: Unpin,

fn read_to_end(&'a mut self, buf: &'a mut Vec<u8, Global>) -> ReadToEnd<'a, Self>where
Self: Unpin,

fn read_to_string(&'a mut self, buf: &'a mut String) -> ReadToString<'a, Self>where
Self: Unpin,

fn split(self) -> (ReadHalf<Self>, WriteHalf<Self>)where
Self: AsyncWrite,

impl<W> AsyncWriteExt for Wwhere
W: AsyncWrite + ?Sized,

fn flush(&mut self) -> Flush<'_, Self>where
Self: Unpin,

fn close(&mut self) -> Close<'_, Self>where
Self: Unpin,

fn write(&'a mut self, buf: &'a [u8]) -> Write<'a, Self>where
Self: Unpin,

fn write_vectored(
&'a mut self,
bufs: &'a [IoSlice<'a>]
) -> WriteVectored<'a, Self>where
Self: Unpin,

fn write_all(&'a mut self, buf: &'a [u8]) -> WriteAll<'a, Self>where
Self: Unpin,

fn into_sink<Item>(self) -> IntoSink<Self, Item>where
Item: AsRef<[u8]>,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,