Struct libp2p_rs::mplex::Mplex

pub struct Mplex<C> where
    C: SplitEx,  {
    pub la: Multiaddr,
    pub ra: Multiaddr,
    pub local_priv_key: Keypair,
    pub local_peer_id: PeerId,
    pub remote_pub_key: PublicKey,
    pub remote_peer_id: PeerId,
    // some fields omitted
}

A Mplex connection.

This implementation isn’t capable of detecting when the underlying socket changes its address, and no [StreamMuxerEvent::AddressChange] event is ever emitted.

Fields

la: Multiaddr

The secure&connection info provided by underlying socket. The socket is moved into Connection, so we have to make a copy of these information

The local multiaddr of this connection

ra: Multiaddr

The remote multiaddr of this connection

local_priv_key: Keypair

The private key of the local

local_peer_id: PeerId

For convenience, the local peer ID, generated from local pub key

remote_pub_key: PublicKey

The public key of the remote.

remote_peer_id: PeerId

For convenience, put a PeerId here, which is actually calculated from remote_key

Implementations

impl<C> Mplex<C> where
    C: SplittableReadWrite + ConnectionInfo + SecureInfo, 

pub fn new(io: C) -> Mplex<C>

Trait Implementations

impl<C> Clone for Mplex<C> where
    C: SplitEx, 

pub fn clone(&self) -> Mplex<C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C> ConnectionInfo for Mplex<C> where
    C: SplitEx, 

pub fn local_multiaddr(&self) -> Multiaddr

pub fn remote_multiaddr(&self) -> Multiaddr

impl<C> Debug for Mplex<C> where
    C: SplitEx, 

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

Formats the value using the given formatter.

impl<C> SecureInfo for Mplex<C> where
    C: SplitEx, 

pub fn local_peer(&self) -> PeerId

pub fn remote_peer(&self) -> PeerId

pub fn local_priv_key(&self) -> Keypair

pub fn remote_pub_key(&self) -> PublicKey

impl<C> StreamMuxer for Mplex<C> where
    C: SplittableReadWrite, 

pub fn open_stream<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = Result<Box<dyn ReadWriteEx + 'static, Global>, TransportError>> + 'async_trait + Send, Global>> where
    'life0: 'async_trait,
    Mplex<C>: 'async_trait, 

Opens a new outgoing substream.

pub fn accept_stream<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = Result<Box<dyn ReadWriteEx + 'static, Global>, TransportError>> + 'async_trait + Send, Global>> where
    'life0: 'async_trait,
    Mplex<C>: 'async_trait, 

Accepts a new incoming substream.

pub fn close<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = Result<(), TransportError>> + 'async_trait + Send, Global>> where
    'life0: 'async_trait,
    Mplex<C>: 'async_trait, 

Closes the stream muxer, the runtime of stream muxer will then exit.

pub fn task(
    &mut self
) -> Option<Pin<Box<dyn Future<Output = ()> + 'static + Send, Global>>>

Returns a Future which represents the main loop of the stream muxer.

pub fn box_clone(&self) -> Box<dyn StreamMuxerEx + 'static, Global>

Returns the cloned Trait object.

impl<C> StreamMuxerEx for Mplex<C> where
    C: SplittableReadWrite,