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_prefix: Cow<'static, str>,
 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

pub 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<TSocket> InboundUpgrade<TSocket> for ProtocolConfig where
TSocket: 'static + AsyncRead + AsyncWrite + Unpin + Send,

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

pub fn upgrade_inbound(
 self,
 socket: TSocket,
 protocol_id: <ProtocolConfig as UpgradeInfo>::Info
) -> <ProtocolConfig as InboundUpgrade<TSocket>>::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 ProtocolConfig where
TSocket: 'static + AsyncWrite + AsyncRead + Unpin + Send,

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

pub fn upgrade_outbound(
 self,
 socket: TSocket,
 protocol_id: <ProtocolConfig as UpgradeInfo>::Info
) -> <ProtocolConfig as OutboundUpgrade<TSocket>>::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

pub fn protocol_info(&self) -> <ProtocolConfig as UpgradeInfo>::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 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<C, U> InboundUpgradeExt<C> for U where
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 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<C, U> OutboundUpgradeExt<C> for U where
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 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::gossipsub::protocol::ProtocolConfig

Implementations

impl ProtocolConfig

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

Trait Implementations

impl Clone for ProtocolConfig

pub fn clone(&self) -> ProtocolConfig

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

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

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

pub fn upgrade_inbound( self, socket: TSocket, protocol_id: <ProtocolConfig as UpgradeInfo>::Info) -> <ProtocolConfig as InboundUpgrade<TSocket>>::Future

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

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

pub fn upgrade_outbound( self, socket: TSocket, protocol_id: <ProtocolConfig as UpgradeInfo>::Info) -> <ProtocolConfig as OutboundUpgrade<TSocket>>::Future

impl UpgradeInfo for ProtocolConfig

type Info = ProtocolId

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

pub fn protocol_info(&self) -> <ProtocolConfig as UpgradeInfo>::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 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<C, U> InboundUpgradeExt<C> for U where 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 T where U: From<T>,

pub fn into(self) -> U

impl<C, U> OutboundUpgradeExt<C> for U where 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 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 new(
id_prefix: Cow<'static, str>,
max_transmit_size: usize,
validation_mode: ValidationMode,
support_floodsub: bool
) -> ProtocolConfig

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

pub fn upgrade_inbound(
self,
socket: TSocket,
protocol_id: <ProtocolConfig as UpgradeInfo>::Info
) -> <ProtocolConfig as InboundUpgrade<TSocket>>::Future

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

pub fn upgrade_outbound(
self,
socket: TSocket,
protocol_id: <ProtocolConfig as UpgradeInfo>::Info
) -> <ProtocolConfig as OutboundUpgrade<TSocket>>::Future

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<C, U> InboundUpgradeExt<C> for U where
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 T where
U: From<T>,

impl<C, U> OutboundUpgradeExt<C> for U where
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 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>,