Struct libp2p::kad::protocol::KademliaProtocolConfig

source · [−]

pub struct KademliaProtocolConfig { /* private fields */ }

Expand description

Configuration for a Kademlia connection upgrade. When applied to a connection, turns this connection into a Stream + Sink whose items are of type KadRequestMsg and KadResponseMsg.

Implementations

source

impl KademliaProtocolConfig

source

pub fn protocol_name(&self) -> &[u8 ]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

Returns the configured protocol name.

source

pub fn set_protocol_name(&mut self, name: impl Into<Cow<'static, [u8 ]>>)

Modifies the protocol name used on the wire. Can be used to create incompatibilities between networks on purpose.

source

pub fn set_max_packet_size(&mut self, size: usize)

Modifies the maximum allowed size of a single Kademlia packet.

Trait Implementations

source

impl Clone for KademliaProtocolConfig

source

pub fn clone(&self) -> KademliaProtocolConfig

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 KademliaProtocolConfig

source

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

Formats the value using the given formatter. Read more

source

impl Default for KademliaProtocolConfig

source

pub fn default() -> KademliaProtocolConfig

Returns the “default value” for a type. Read more

source

impl<C> InboundUpgrade<C> for KademliaProtocolConfig where
C: AsyncRead + AsyncWrite + Unpin,

type Output = AndThen<With<ErrInto<Framed<C, UviBytes<Cursor<Vec<u8, Global>>>>, Error>, Cursor<Vec<u8, Global>>, KadResponseMsg, Ready<Result<Cursor<Vec<u8, Global>>, Error>>, fn(KadResponseMsg) -> Ready<Result<Cursor<Vec<u8, Global>>, Error>>>, Ready<Result<KadRequestMsg, Error>>, fn(BytesMut) -> Ready<Result<KadRequestMsg, Error>>>

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

type Future = Ready<Result<<KademliaProtocolConfig as InboundUpgrade<C>>::Output, Error>>

Future that performs the handshake with the remote.

type Error = Error

Possible error during the handshake.

source

pub fn upgrade_inbound(
 self,
 incoming: C,
 <KademliaProtocolConfig as UpgradeInfo>::Info
) -> <KademliaProtocolConfig as InboundUpgrade<C>>::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<C> OutboundUpgrade<C> for KademliaProtocolConfig where
C: AsyncRead + AsyncWrite + Unpin,

type Output = AndThen<With<ErrInto<Framed<C, UviBytes<Cursor<Vec<u8, Global>>>>, Error>, Cursor<Vec<u8, Global>>, KadRequestMsg, Ready<Result<Cursor<Vec<u8, Global>>, Error>>, fn(KadRequestMsg) -> Ready<Result<Cursor<Vec<u8, Global>>, Error>>>, Ready<Result<KadResponseMsg, Error>>, fn(BytesMut) -> Ready<Result<KadResponseMsg, Error>>>

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

type Future = Ready<Result<<KademliaProtocolConfig as OutboundUpgrade<C>>::Output, Error>>

Future that performs the handshake with the remote.

type Error = Error

Possible error during the handshake.

source

pub fn upgrade_outbound(
 self,
 incoming: C,
 <KademliaProtocolConfig as UpgradeInfo>::Info
) -> <KademliaProtocolConfig as OutboundUpgrade<C>>::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 KademliaProtocolConfig

type Info = Cow<'static, [u8 ]>

Opaque type representing a negotiable protocol.

type InfoIter = Once<<KademliaProtocolConfig as UpgradeInfo>::Info>

Iterator returned by protocol_info.

source

pub fn protocol_info(&self) -> <KademliaProtocolConfig as UpgradeInfo>::InfoIter

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

Auto Trait Implementations

impl RefUnwindSafe for KademliaProtocolConfig

impl Send for KademliaProtocolConfig

impl Sync for KademliaProtocolConfig

impl Unpin for KademliaProtocolConfig

impl UnwindSafe for KademliaProtocolConfig

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::kad::protocol::KademliaProtocolConfig

Implementations

impl KademliaProtocolConfig

pub fn protocol_name(&self) -> &[u8]ⓘNotable traits for &'_ [u8]impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]

pub fn set_protocol_name(&mut self, name: impl Into<Cow<'static, [u8]>>)

pub fn set_max_packet_size(&mut self, size: usize)

Trait Implementations

impl Clone for KademliaProtocolConfig

pub fn clone(&self) -> KademliaProtocolConfig

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

impl Debug for KademliaProtocolConfig

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

impl Default for KademliaProtocolConfig

pub fn default() -> KademliaProtocolConfig

impl<C> InboundUpgrade<C> for KademliaProtocolConfig where C: AsyncRead + AsyncWrite + Unpin,

type Future = Ready<Result<<KademliaProtocolConfig as InboundUpgrade<C>>::Output, Error>>

type Error = Error

pub fn upgrade_inbound( self, incoming: C, <KademliaProtocolConfig as UpgradeInfo>::Info) -> <KademliaProtocolConfig as InboundUpgrade<C>>::Future

impl<C> OutboundUpgrade<C> for KademliaProtocolConfig where C: AsyncRead + AsyncWrite + Unpin,

type Future = Ready<Result<<KademliaProtocolConfig as OutboundUpgrade<C>>::Output, Error>>

type Error = Error

pub fn upgrade_outbound( self, incoming: C, <KademliaProtocolConfig as UpgradeInfo>::Info) -> <KademliaProtocolConfig as OutboundUpgrade<C>>::Future

impl UpgradeInfo for KademliaProtocolConfig

type Info = Cow<'static, [u8]>

type InfoIter = Once<<KademliaProtocolConfig as UpgradeInfo>::Info>

pub fn protocol_info(&self) -> <KademliaProtocolConfig as UpgradeInfo>::InfoIter

Auto Trait Implementations

impl RefUnwindSafe for KademliaProtocolConfig

impl Send for KademliaProtocolConfig

impl Sync for KademliaProtocolConfig

impl Unpin for KademliaProtocolConfig

impl UnwindSafe for KademliaProtocolConfig

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 protocol_name(&self) -> &[u8 ]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

pub fn set_protocol_name(&mut self, name: impl Into<Cow<'static, [u8 ]>>)

impl<C> InboundUpgrade<C> for KademliaProtocolConfig where
C: AsyncRead + AsyncWrite + Unpin,

pub fn upgrade_inbound(
self,
incoming: C,
<KademliaProtocolConfig as UpgradeInfo>::Info
) -> <KademliaProtocolConfig as InboundUpgrade<C>>::Future

impl<C> OutboundUpgrade<C> for KademliaProtocolConfig where
C: AsyncRead + AsyncWrite + Unpin,

pub fn upgrade_outbound(
self,
incoming: C,
<KademliaProtocolConfig as UpgradeInfo>::Info
) -> <KademliaProtocolConfig as OutboundUpgrade<C>>::Future

type Info = Cow<'static, [u8 ]>

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