Struct libp2p_rs::swarm::substream::Substream

pub struct Substream { /* fields omitted */ }

Substream is the logical channel for the p2p connection. SubstreamMeta contains the meta information of the substream and IReadWrite provides the I/O operation to Substream.

Implementations

impl Substream

pub fn to_view(&self) -> SubstreamView

Builds a SubstreamView struct.

pub fn protocol(&self) -> &ProtocolId

Returns the protocol of the sub stream.

pub fn dir(&self) -> Direction

Returns the direction of the sub stream.

pub fn cid(&self) -> ConnectionId

Returns the connection id of the sub stream.

pub fn id(&self) -> StreamId

Returns the sub stream Id.

pub fn remote_multiaddr(&self) -> Multiaddr

Returns the remote multiaddr of the sub stream.

pub fn local_multiaddr(&self) -> Multiaddr

Returns the remote multiaddr of the sub stream.

pub fn remote_peer(&self) -> PeerId

Returns the remote multiaddr of the sub stream.

pub fn info(&self) -> SubstreamInfo

Returns the info of the sub stream.

Trait Implementations

impl Clone for Substream

pub fn clone(&self) -> Substream

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Substream

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

Formats the value using the given formatter.

impl Drop for Substream

pub fn drop(&mut self)

Executes the destructor for this type.

impl ReadEx for Substream

pub fn read2<'life0, 'life1, 'async_trait>(
    &'life0 mut self,
    buf: &'life1 mut [u8]
) -> Pin<Box<dyn Future<Output = Result<usize, Error>> + 'async_trait + Send, Global>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Substream: 'async_trait, 

Reads some bytes from the byte stream.

#[must_use]pub fn read_exact2<'a, 'async_trait>(
    &'a mut self,
    buf: &'a mut [u8]
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + 'async_trait + Send, Global>> where
    'a: 'async_trait,
    Self: 'async_trait, 

Reads the exact number of bytes requested.

#[must_use]pub fn read_fixed_u32<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = Result<usize, Error>> + 'async_trait + Send, Global>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Reads a fixed-length integer from the underlying IO.

#[must_use]pub fn read_varint<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = Result<usize, Error>> + 'async_trait + Send, Global>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Reads a variable-length integer from the underlying IO.

#[must_use]pub fn read_one_fixed<'life0, 'async_trait>(
    &'life0 mut self,
    max_size: usize
) -> Pin<Box<dyn Future<Output = Result<Vec<u8, Global>, Error>> + 'async_trait + Send, Global>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Reads a fixed length-prefixed message from the underlying IO.

#[must_use]pub fn read_one<'life0, 'async_trait>(
    &'life0 mut self,
    max_size: usize
) -> Pin<Box<dyn Future<Output = Result<Vec<u8, Global>, Error>> + 'async_trait + Send, Global>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Reads a variable length-prefixed message from the underlying IO.

impl WriteEx for Substream

pub fn write2<'life0, 'life1, 'async_trait>(
    &'life0 mut self,
    buf: &'life1 [u8]
) -> Pin<Box<dyn Future<Output = Result<usize, Error>> + 'async_trait + Send, Global>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Substream: 'async_trait, 

Attempt to write bytes from buf into the object.

pub fn flush2<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + 'async_trait + Send, Global>> where
    'life0: 'async_trait,
    Substream: 'async_trait, 

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

pub fn close2<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + 'async_trait + Send, Global>> where
    'life0: 'async_trait,
    Substream: 'async_trait, 

Attempt to close the object.

#[must_use]pub fn write_all2<'life0, 'life1, 'async_trait>(
    &'life0 mut self,
    buf: &'life1 [u8]
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + 'async_trait + Send, Global>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Attempt to write the entire contents of data into object.

#[must_use]pub fn write_varint<'life0, 'async_trait>(
    &'life0 mut self,
    len: usize
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + 'async_trait + Send, Global>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Writes a variable-length integer to the underlying IO.

#[must_use]pub fn write_fixed_u32<'life0, 'async_trait>(
    &'life0 mut self,
    len: usize
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + 'async_trait + Send, Global>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Writes a fixed-length integer to the underlying IO.

#[must_use]pub fn write_one_fixed<'life0, 'life1, 'async_trait>(
    &'life0 mut self,
    buf: &'life1 [u8]
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + 'async_trait + Send, Global>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Send a fixed length message to the underlying IO, then flushes the writing side.

#[must_use]pub fn write_one<'life0, 'life1, 'async_trait>(
    &'life0 mut self,
    buf: &'life1 [u8]
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + 'async_trait + Send, Global>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Send a variable length message to the underlying IO, then flushes the writing side.