libp2p::swarm

Struct SubstreamProtocol

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§

§

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. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
§

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. Read more
§

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

§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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> StructuralPartialEq for SubstreamProtocol<TUpgrade, TInfo>

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

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

§

impl<TUpgrade, TInfo> UnwindSafe for SubstreamProtocol<TUpgrade, TInfo>
where TUpgrade: UnwindSafe, TInfo: 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
§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

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

Source§

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

Source§

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

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> MaybeSendSync for T