Struct libp2p::swarm::SubstreamProtocol

pub struct SubstreamProtocol<TUpgrade, TInfo> { /* private fields */ }

Configuration of inbound or outbound substream protocol(s) for a ConnectionHandler.

The inbound substream protocol(s) are defined by ConnectionHandler::listen_protocol and the outbound substream protocol(s) by ConnectionHandlerEvent::OutboundSubstreamRequest.

Implementations

impl<TUpgrade, TInfo> SubstreamProtocol<TUpgrade, TInfo>

pub fn new(upgrade: TUpgrade, info: TInfo) -> SubstreamProtocol<TUpgrade, TInfo>

Create a new SubstreamProtocol from the given upgrade.

The default timeout for applying the given upgrade on a substream is 10 seconds.

pub fn map_upgrade<U, F>(self, f: F) -> SubstreamProtocol<U, TInfo>where F: FnOnce(TUpgrade) -> U,

Maps a function over the protocol upgrade.

pub fn map_info<U, F>(self, f: F) -> SubstreamProtocol<TUpgrade, U>where F: FnOnce(TInfo) -> U,

Maps a function over the protocol info.

pub fn with_timeout( self, timeout: Duration ) -> SubstreamProtocol<TUpgrade, TInfo>

Sets a new timeout for the protocol upgrade.

pub fn upgrade(&self) -> &TUpgrade

Borrows the contained protocol upgrade.

pub fn info(&self) -> &TInfo

Borrows the contained protocol info.

pub fn timeout(&self) -> &Duration

Borrows the timeout for the protocol upgrade.

pub fn into_upgrade(self) -> (TUpgrade, TInfo)

Converts the substream protocol configuration into the contained upgrade.

Trait Implementations

impl<TUpgrade, TInfo> Clone for SubstreamProtocol<TUpgrade, TInfo>where TUpgrade: Clone, TInfo: Clone,

fn clone(&self) -> SubstreamProtocol<TUpgrade, TInfo>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<TUpgrade, TInfo> Debug for SubstreamProtocol<TUpgrade, TInfo>where TUpgrade: Debug, TInfo: Debug,

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

Formats the value using the given formatter.

impl<TUpgrade, TInfo> PartialEq<SubstreamProtocol<TUpgrade, TInfo>> for SubstreamProtocol<TUpgrade, TInfo>where TUpgrade: PartialEq<TUpgrade>, TInfo: PartialEq<TInfo>,

fn eq(&self, other: &SubstreamProtocol<TUpgrade, TInfo>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<TUpgrade, TInfo> Copy for SubstreamProtocol<TUpgrade, TInfo>where TUpgrade: Copy, TInfo: Copy,

impl<TUpgrade, TInfo> Eq for SubstreamProtocol<TUpgrade, TInfo>where TUpgrade: Eq, TInfo: Eq,

impl<TUpgrade, TInfo> StructuralEq for SubstreamProtocol<TUpgrade, TInfo>

impl<TUpgrade, TInfo> StructuralPartialEq for SubstreamProtocol<TUpgrade, TInfo>