Struct libp2p_swarm::protocols_handler::SubstreamProtocol

source · [−]

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

Expand description

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

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

Implementations

source

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

source

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

Create a new SubstreamProtocol from the given upgrade.

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

source

pub fn with_upgrade_protocol(self, version: Version) -> Self

Sets the multistream-select protocol (version) to use for negotiating protocols upgrades on outbound substreams.

source

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

Maps a function over the protocol upgrade.

source

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

Maps a function over the protocol info.

source

pub fn with_timeout(self, timeout: Duration) -> Self

Sets a new timeout for the protocol upgrade.

source

pub fn upgrade(&self) -> &TUpgrade

Borrows the contained protocol upgrade.

source

pub fn info(&self) -> &TInfo

Borrows the contained protocol info.

source

pub fn timeout(&self) -> &Duration

Borrows the timeout for the protocol upgrade.

source

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

Converts the substream protocol configuration into the contained upgrade.

Trait Implementations

source

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

source

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

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

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

source

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

Formats the value using the given formatter. Read more

source

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

source

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

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

source

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

This method tests for !=.

source

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

Auto Trait Implementations

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

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

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

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

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

Blanket Implementations

source

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

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

pub 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

pub fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · source

pub 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> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

source

Struct libp2p_swarm::protocols_handler::SubstreamProtocol

Implementations

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

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

pub fn with_upgrade_protocol(self, version: Version) -> Self

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

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

pub fn with_timeout(self, timeout: Duration) -> Self

pub fn upgrade(&self) -> &TUpgrade

pub fn info(&self) -> &TInfo

pub fn timeout(&self) -> &Duration

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

Trait Implementations

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

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

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

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

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

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

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

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

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

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

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

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

Auto Trait Implementations

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

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

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

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

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

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

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

pub fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<T> ToOwned for T where T: Clone,

type Owned = T

pub fn to_owned(&self) -> T

pub fn clone_into(&self, target: &mut T)

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

type Error = Infallible

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

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

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

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

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

pub fn vzip(self) -> V

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

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

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

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

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

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

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

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

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

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

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

impl<T> ToOwned for T where
T: Clone,

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

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

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