Struct libp2p_ping::protocol::Ping

source ·

pub struct Ping<TUserData = ()>(_);

Expand description

Represents a prototype for an upgrade to handle the ping protocol.

According to the design of libp2p, this struct would normally contain the configuration options for the protocol, but in the case of Ping no configuration is required.

Trait Implementations§

source §

impl<TUserData: Clone> Clone for Ping<TUserData>

source §

fn clone(&self) -> Ping<TUserData>

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<TUserData: Debug> Debug for Ping<TUserData>

source §

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

Formats the value using the given formatter. Read more

source §

impl<TUserData> Default for Ping<TUserData>

source §

fn default() -> Self

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

source §

impl<TSocket, TUserData> InboundUpgrade<TSocket> for Ping<TUserData>where
TSocket: AsyncRead + AsyncWrite,

§

type Output = PingListener<TSocket>

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

§

type Error = Error

Possible error during the handshake.

§

type Future = FutureResult<<Ping<TUserData> as InboundUpgrade<TSocket>>::Output, <Ping<TUserData> as InboundUpgrade<TSocket>>::Error>

Future that performs the handshake with the remote.

source §

fn upgrade_inbound(self, socket: TSocket, _: 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, TUserData> OutboundUpgrade<TSocket> for Ping<TUserData>where
TSocket: AsyncRead + AsyncWrite,

§

type Output = PingDialer<TSocket, TUserData>

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

§

type Error = Error

Possible error during the handshake.

§

type Future = FutureResult<<Ping<TUserData> as OutboundUpgrade<TSocket>>::Output, <Ping<TUserData> as OutboundUpgrade<TSocket>>::Error>

Future that performs the handshake with the remote.

source §

fn upgrade_outbound(self, socket: TSocket, _: 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<TUserData> UpgradeInfo for Ping<TUserData>

§

type Info = &'static [u8]

Opaque type representing a negotiable protocol.

§

type InfoIter = Once<<Ping<TUserData> as UpgradeInfo>::Info>

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.

source §

impl<TUserData: Copy> Copy for Ping<TUserData>

Auto Trait Implementations§

§

impl<TUserData> RefUnwindSafe for Ping<TUserData>where
TUserData: RefUnwindSafe,

§

impl<TUserData> UnwindSafe for Ping<TUserData>where
TUserData: UnwindSafe,

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, 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
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> 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_ping::protocol::Ping

Trait Implementations§

impl<TUserData: Clone> Clone for Ping<TUserData>

fn clone(&self) -> Ping<TUserData>

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

impl<TUserData: Debug> Debug for Ping<TUserData>

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

impl<TUserData> Default for Ping<TUserData>

fn default() -> Self

impl<TSocket, TUserData> InboundUpgrade<TSocket> for Ping<TUserData>where TSocket: AsyncRead + AsyncWrite,

type Output = PingListener<TSocket>

type Error = Error

type Future = FutureResult<<Ping<TUserData> as InboundUpgrade<TSocket>>::Output, <Ping<TUserData> as InboundUpgrade<TSocket>>::Error>

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

impl<TSocket, TUserData> OutboundUpgrade<TSocket> for Ping<TUserData>where TSocket: AsyncRead + AsyncWrite,

type Output = PingDialer<TSocket, TUserData>

type Error = Error

type Future = FutureResult<<Ping<TUserData> as OutboundUpgrade<TSocket>>::Output, <Ping<TUserData> as OutboundUpgrade<TSocket>>::Error>

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

impl<TUserData> UpgradeInfo for Ping<TUserData>

type Info = &'static [u8]

type InfoIter = Once<<Ping<TUserData> as UpgradeInfo>::Info>

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

impl<TUserData: Copy> Copy for Ping<TUserData>

Auto Trait Implementations§

impl<TUserData> RefUnwindSafe for Ping<TUserData>where TUserData: RefUnwindSafe,

impl<TUserData> Send for Ping<TUserData>where TUserData: Send,

impl<TUserData> Sync for Ping<TUserData>where TUserData: Sync,

impl<TUserData> Unpin for Ping<TUserData>where TUserData: Unpin,

impl<TUserData> UnwindSafe for Ping<TUserData>where TUserData: UnwindSafe,

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

fn map_inbound_err<F, T>(self, f: F) -> MapInboundUpgradeErr<Self, F>where Self: Sized, 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 Self: Sized, F: FnOnce(Self::Output) -> T,

fn map_outbound_err<F, T>(self, f: F) -> MapOutboundUpgradeErr<Self, F>where Self: Sized, 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<T> Erased for T

impl<TSocket, TUserData> InboundUpgrade<TSocket> for Ping<TUserData>where
TSocket: AsyncRead + AsyncWrite,

impl<TSocket, TUserData> OutboundUpgrade<TSocket> for Ping<TUserData>where
TSocket: AsyncRead + AsyncWrite,

impl<TUserData> RefUnwindSafe for Ping<TUserData>where
TUserData: RefUnwindSafe,

impl<TUserData> Send for Ping<TUserData>where
TUserData: Send,

impl<TUserData> Sync for Ping<TUserData>where
TUserData: Sync,

impl<TUserData> Unpin for Ping<TUserData>where
TUserData: Unpin,

impl<TUserData> UnwindSafe for Ping<TUserData>where
TUserData: UnwindSafe,

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

fn map_inbound_err<F, T>(self, f: F) -> MapInboundUpgradeErr<Self, F>where
Self: Sized,
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
Self: Sized,
F: FnOnce(Self::Output) -> T,

fn map_outbound_err<F, T>(self, f: F) -> MapOutboundUpgradeErr<Self, F>where
Self: Sized,
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>,