Struct libp2p_gossipsub::protocol::ProtocolConfig

source · 
pub struct ProtocolConfig { /* private fields */ }
Expand description

Implementation of InboundUpgrade and OutboundUpgrade for the Gossipsub protocol.

Implementations§

source§

impl ProtocolConfig

source

pub fn new(gossipsub_config: &Config) -> ProtocolConfig

Builds a new ProtocolConfig.

Sets the maximum gossip transmission size.

Trait Implementations§

source§

impl Clone for ProtocolConfig

source§

fn clone(&self) -> ProtocolConfig

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 Debug for ProtocolConfig

source§

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

Formats the value using the given formatter. Read more
source§

impl<TSocket> InboundUpgrade<TSocket> for ProtocolConfigwhere TSocket: AsyncRead + AsyncWrite + Unpin + Send + 'static,

§

type Output = (Framed<TSocket, GossipsubCodec>, PeerKind)

Output after the upgrade has been successfully negotiated and the handshake performed.
§

type Error = HandlerError

Possible error during the handshake.
§

type Future = Pin<Box<dyn Future<Output = Result<<ProtocolConfig as InboundUpgrade<TSocket>>::Output, <ProtocolConfig as InboundUpgrade<TSocket>>::Error>> + Send + 'static, Global>>

Future that performs the handshake with the remote.
source§

fn upgrade_inbound( self, socket: TSocket, protocol_id: Self::Info ) -> Self::Future

After we have determined that the remote supports one of the protocols we support, this method is called to start the handshake. Read more
source§

impl<TSocket> OutboundUpgrade<TSocket> for ProtocolConfigwhere TSocket: AsyncWrite + AsyncRead + Unpin + Send + 'static,

§

type Output = (Framed<TSocket, GossipsubCodec>, PeerKind)

Output after the upgrade has been successfully negotiated and the handshake performed.
§

type Error = HandlerError

Possible error during the handshake.
§

type Future = Pin<Box<dyn Future<Output = Result<<ProtocolConfig as OutboundUpgrade<TSocket>>::Output, <ProtocolConfig as OutboundUpgrade<TSocket>>::Error>> + Send + 'static, Global>>

Future that performs the handshake with the remote.
source§

fn upgrade_outbound( self, socket: TSocket, protocol_id: Self::Info ) -> Self::Future

After we have determined that the remote supports one of the protocols we support, this method is called to start the handshake. Read more
source§

impl UpgradeInfo for ProtocolConfig

§

type Info = ProtocolId

Opaque type representing a negotiable protocol.
§

type InfoIter = Vec<<ProtocolConfig as UpgradeInfo>::Info, Global>

Iterator returned by protocol_info.
source§

fn protocol_info(&self) -> Self::InfoIter

Returns the list of protocols that are supported. Used during the negotiation process.

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

const: unstable · source§

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§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<C, U> InboundUpgradeExt<C> for Uwhere U: InboundUpgrade<C>,

source§

fn map_inbound<F, T>(self, f: F) -> MapInboundUpgrade<Self, F>where Self: Sized, F: FnOnce(Self::Output) -> T,

Returns a new object that wraps around Self and applies a closure to the Output.
source§

fn map_inbound_err<F, T>(self, f: F) -> MapInboundUpgradeErr<Self, F>where Self: Sized, F: FnOnce(Self::Error) -> T,

Returns a new object that wraps around Self and applies a closure to the Error.
source§

impl<T, TInfo> InboundUpgradeSend for Twhere T: InboundUpgrade<Negotiated<SubstreamBox>, Info = TInfo> + UpgradeInfoSend<Info = TInfo>, TInfo: ProtocolName + Clone + Send + 'static, <T as InboundUpgrade<Negotiated<SubstreamBox>>>::Output: Send + 'static, <T as InboundUpgrade<Negotiated<SubstreamBox>>>::Error: Send + 'static, <T as InboundUpgrade<Negotiated<SubstreamBox>>>::Future: Send + 'static,

§

type Output = <T as InboundUpgrade<Negotiated<SubstreamBox>>>::Output

Equivalent to InboundUpgrade::Output.
§

type Error = <T as InboundUpgrade<Negotiated<SubstreamBox>>>::Error

Equivalent to InboundUpgrade::Error.
§

type Future = <T as InboundUpgrade<Negotiated<SubstreamBox>>>::Future

Equivalent to InboundUpgrade::Future.
source§

fn upgrade_inbound( self, socket: Negotiated<SubstreamBox>, info: TInfo ) -> <T as InboundUpgradeSend>::Future

Equivalent to InboundUpgrade::upgrade_inbound.
source§

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

const: unstable · 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<C, U> OutboundUpgradeExt<C> for Uwhere U: OutboundUpgrade<C>,

source§

fn map_outbound<F, T>(self, f: F) -> MapOutboundUpgrade<Self, F>where Self: Sized, F: FnOnce(Self::Output) -> T,

Returns a new object that wraps around Self and applies a closure to the Output.
source§

fn map_outbound_err<F, T>(self, f: F) -> MapOutboundUpgradeErr<Self, F>where Self: Sized, F: FnOnce(Self::Error) -> T,

Returns a new object that wraps around Self and applies a closure to the Error.
source§

impl<T, TInfo> OutboundUpgradeSend for Twhere T: OutboundUpgrade<Negotiated<SubstreamBox>, Info = TInfo> + UpgradeInfoSend<Info = TInfo>, TInfo: ProtocolName + Clone + Send + 'static, <T as OutboundUpgrade<Negotiated<SubstreamBox>>>::Output: Send + 'static, <T as OutboundUpgrade<Negotiated<SubstreamBox>>>::Error: Send + 'static, <T as OutboundUpgrade<Negotiated<SubstreamBox>>>::Future: Send + 'static,

§

type Output = <T as OutboundUpgrade<Negotiated<SubstreamBox>>>::Output

Equivalent to OutboundUpgrade::Output.
§

type Error = <T as OutboundUpgrade<Negotiated<SubstreamBox>>>::Error

Equivalent to OutboundUpgrade::Error.
§

type Future = <T as OutboundUpgrade<Negotiated<SubstreamBox>>>::Future

Equivalent to OutboundUpgrade::Future.
source§

fn upgrade_outbound( self, socket: Negotiated<SubstreamBox>, info: TInfo ) -> <T as OutboundUpgradeSend>::Future

Equivalent to OutboundUpgrade::upgrade_outbound.
source§

impl<T> Same<T> for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for Twhere 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 Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.
source§

impl<T> UpgradeInfoSend for Twhere T: UpgradeInfo + Send + 'static, <T as UpgradeInfo>::Info: Send + 'static, <<T as UpgradeInfo>::InfoIter as IntoIterator>::IntoIter: Send + 'static,

§

type Info = <T as UpgradeInfo>::Info

Equivalent to UpgradeInfo::Info.
§

type InfoIter = <<T as UpgradeInfo>::InfoIter as IntoIterator>::IntoIter

Equivalent to UpgradeInfo::InfoIter.
source§

fn protocol_info(&self) -> <T as UpgradeInfoSend>::InfoIter

Equivalent to UpgradeInfo::protocol_info.
§

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

§

fn vzip(self) -> V