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

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§

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 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) -> (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 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 ==.
1.0.0 · source§

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.
source§

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

source§

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

source§

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

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§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

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

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 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§

fn to_owned(&self) -> T

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

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

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

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more