Struct Ping 

pub struct Ping<I, A> {
    pub sequence_number: u32,
    pub source: Node<I, A>,
    pub target: Node<I, A>,
}

Ping is sent to a target to check if it is alive

Fields

sequence_number: u32

The sequence number of the ack

source: Node<I, A>

Source target, used for a direct reply

target: Node<I, A>

Node is sent so the target can verify they are the intended recipient. This is to protect again an agent restart with a new name.

Implementations

impl<I, A> Ping<I, A>

pub const fn sequence_number(&self) -> u32

Returns the sequence number of the ack

pub const fn source(&self) -> &Node<I, A>

Returns the source node of the ping message

pub const fn target(&self) -> &Node<I, A>

Returns the target node of the ping message

pub const fn with_sequence_number(self, val: u32) -> Self

Sets the sequence number of the ack (Builder pattern)

pub fn with_source(self, val: Node<I, A>) -> Self

Sets the source node of the ping message (Builder pattern)

pub fn with_target(self, val: Node<I, A>) -> Self

Sets the target node of the ping message (Builder pattern)

impl<I, A> Ping<I, A>

pub const fn new( sequence_number: u32, source: Node<I, A>, target: Node<I, A>, ) -> Self

Create a new message

pub fn set_sequence_number(&mut self, sequence_number: u32) -> &mut Self

Sets the sequence number of the message

pub fn set_source(&mut self, source: Node<I, A>) -> &mut Self

Sets the source node of the message

pub fn set_target(&mut self, target: Node<I, A>) -> &mut Self

Sets the target node of the message

Trait Implementations

impl<I, A> Archive for Ping<I, A>

where u32: Archive, Node<I, A>: Archive,

type Archived = ArchivedPing<I, A>

The archived representation of this type.

type Resolver = PingResolver<I, A>

The resolver for this type. It must contain all the additional information from serializing needed to make the archived type from the normal type.

fn resolve(&self, resolver: Self::Resolver, out: Place<Self::Archived>)

Creates the archived version of this value at the given position and writes it to the given output.

const COPY_OPTIMIZATION: CopyOptimization<Self> = _

An optimization flag that allows the bytes of this type to be copied directly to a writer instead of calling serialize.

impl<I: CheapClone, A: CheapClone> CheapClone for Ping<I, A>

fn cheap_clone(&self) -> Self

Returns a copy of the value.

impl<I: Clone, A: Clone> Clone for Ping<I, A>

fn clone(&self) -> Ping<I, A>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<I: Debug, A: Debug> Debug for Ping<I, A>

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

Formats the value using the given formatter.

impl<'de, I, A> Deserialize<'de> for Ping<I, A>

where I: Deserialize<'de>, A: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<__D: Fallible + ?Sized, I, A> Deserialize<Ping<I, A>, __D> for Archived<Ping<I, A>>

where u32: Archive, <u32 as Archive>::Archived: Deserialize<u32, __D>, Node<I, A>: Archive, <Node<I, A> as Archive>::Archived: Deserialize<Node<I, A>, __D>,

fn deserialize( &self, deserializer: &mut __D, ) -> Result<Ping<I, A>, <__D as Fallible>::Error>

Deserializes using the given deserializer

impl<I, A> From<IndirectPing<I, A>> for Ping<I, A>

fn from(ping: IndirectPing<I, A>) -> Self

Converts to this type from the input type.

impl<I, A> From<Ping<I, A>> for Message<I, A>

fn from(value: Ping<I, A>) -> Self

Converts to this type from the input type.

impl<I: Hash, A: Hash> Hash for Ping<I, A>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<I, A> PartialEq<ArchivedPing<I, A>> for Ping<I, A>

where u32: Archive, Node<I, A>: Archive, <u32 as Archive>::Archived: PartialEq<u32>, <Node<I, A> as Archive>::Archived: PartialEq<Node<I, A>>,

fn eq(&self, other: &ArchivedPing<I, A>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<I, A> PartialEq<Ping<I, A>> for ArchivedPing<I, A>

where u32: Archive, Node<I, A>: Archive, <u32 as Archive>::Archived: PartialEq<u32>, <Node<I, A> as Archive>::Archived: PartialEq<Node<I, A>>,

fn eq(&self, other: &Ping<I, A>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<I: PartialEq, A: PartialEq> PartialEq for Ping<I, A>

fn eq(&self, other: &Ping<I, A>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<__S: Fallible + ?Sized, I, A> Serialize<__S> for Ping<I, A>

where u32: Serialize<__S>, Node<I, A>: Serialize<__S>,

fn serialize( &self, serializer: &mut __S, ) -> Result<<Self as Archive>::Resolver, <__S as Fallible>::Error>

Writes the dependencies for the object and returns a resolver that can create the archived type.

impl<I, A> Serialize for Ping<I, A>

where I: Serialize, A: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<I: Transformable, A: Transformable> Transformable for Ping<I, A>

type Error = PingTransformError<I, A>

The error type returned when encoding or decoding fails.

fn encode(&self, dst: &mut [u8]) -> Result<usize, Self::Error>

Encodes the value into the given buffer for transmission.

fn encoded_len(&self) -> usize

Returns the encoded length of the value. This is used to pre-allocate a buffer for encoding.

fn decode(src: &[u8]) -> Result<(usize, Self), Self::Error>

where Self: Sized,

Decodes the value from the given buffer received over the wire.

fn encode_to_vec(&self) -> Result<Vec<u8>, Self::Error>

Available on crate features alloc or std only.

Encodes the value into a vec for transmission.

fn encode_to_writer<W>(&self, writer: &mut W) -> Result<usize, Error>

where W: Write,

Available on crate feature std only.

Encodes the value into the given writer for transmission.

fn encode_to_async_writer<W>( &self, writer: &mut W, ) -> impl Future<Output = Result<usize, Error>> + Send

where W: AsyncWrite + Send + Unpin,

Available on crate feature async only.

Encodes the value into the given async writer for transmission.

fn decode_from_reader<R>(reader: &mut R) -> Result<(usize, Self), Error>

where R: Read, Self: Sized,

Available on crate feature std only.

Decodes the value from the given reader received over the wire.

fn decode_from_async_reader<R>( reader: &mut R, ) -> impl Future<Output = Result<(usize, Self), Error>> + Send

where R: AsyncRead + Send + Unpin, Self: Sized,

Available on crate feature async only.

Decodes the value from the given async reader received over the wire.

impl<I: Eq, A: Eq> Eq for Ping<I, A>

impl<I, A> StructuralPartialEq for Ping<I, A>