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(
 id: Cow<'static, str>,
 custom_id_peer_kind: Option<GossipsubVersion>,
 max_transmit_size: usize,
 validation_mode: ValidationMode,
 support_floodsub: bool
) -> 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

const 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 = GossipsubHandlerError

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 = GossipsubHandlerError

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

impl RefUnwindSafe for ProtocolConfig

impl Send for ProtocolConfig

impl Sync for ProtocolConfig

impl Unpin for ProtocolConfig

impl UnwindSafe for ProtocolConfig

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
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
F: FnOnce(Self::Error) -> T,

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

source

impl<T, U> Into 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
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
F: FnOnce(Self::Error) -> T,

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

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 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>::Error>

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Struct libp2p_gossipsub::protocol::ProtocolConfig

Implementations

impl ProtocolConfig

pub fn new( id: Cow<'static, str>, custom_id_peer_kind: Option<GossipsubVersion>, max_transmit_size: usize, validation_mode: ValidationMode, support_floodsub: bool) -> ProtocolConfig

Trait Implementations

impl Clone for ProtocolConfig

fn clone(&self) -> ProtocolConfig

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

impl Debug for ProtocolConfig

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

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

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

type Error = GossipsubHandlerError

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

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

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

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

type Error = GossipsubHandlerError

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

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

impl UpgradeInfo for ProtocolConfig

type Info = ProtocolId

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

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

Auto Trait Implementations

impl RefUnwindSafe for ProtocolConfig

impl Send for ProtocolConfig

impl Sync for ProtocolConfig

impl Unpin for ProtocolConfig

impl UnwindSafe for ProtocolConfig

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

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

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

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

fn into(self) -> U

impl<C, U> OutboundUpgradeExt<C> for Uwhere U: OutboundUpgrade<C>,

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

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

impl<T> Same<T> for T

type Output = T

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

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

fn vzip(self) -> V

pub fn new(
id: Cow<'static, str>,
custom_id_peer_kind: Option<GossipsubVersion>,
max_transmit_size: usize,
validation_mode: ValidationMode,
support_floodsub: bool
) -> ProtocolConfig

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

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

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

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

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

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

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

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

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

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

impl<C, U> OutboundUpgradeExt<C> for Uwhere
U: OutboundUpgrade<C>,

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

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

impl<T> ToOwned for Twhere
T: Clone,

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

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

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