Struct Ping

pub struct Ping {
    pub timestamp: Option<u64>,
    pub good: Option<u32>,
    pub late: Option<u32>,
    pub lost: Option<u32>,
    pub resync: Option<u32>,
    pub udp_packets: Option<u32>,
    pub tcp_packets: Option<u32>,
    pub udp_ping_avg: Option<f32>,
    pub udp_ping_var: Option<f32>,
    pub tcp_ping_avg: Option<f32>,
    pub tcp_ping_var: Option<f32>,
}

Sent by the client to notify the server that the client is still alive. Server must reply to the packet with the same timestamp and its own good/late/lost/resync numbers. None of the fields is strictly required.

Fields

timestamp: Option<u64>

Client timestamp. Server should not attempt to decode.

good: Option<u32>

The amount of good packets received.

late: Option<u32>

The amount of late packets received.

lost: Option<u32>

The amount of packets never received.

resync: Option<u32>

The amount of nonce resyncs.

udp_packets: Option<u32>

The total amount of UDP packets received.

tcp_packets: Option<u32>

The total amount of TCP packets received.

udp_ping_avg: Option<f32>

UDP ping average.

udp_ping_var: Option<f32>

UDP ping variance.

tcp_ping_avg: Option<f32>

TCP ping average.

tcp_ping_var: Option<f32>

TCP ping variance.

Implementations

impl Ping

pub fn timestamp(&self) -> u64

Returns the value of timestamp, or the default value if timestamp is unset.

pub fn good(&self) -> u32

Returns the value of good, or the default value if good is unset.

pub fn late(&self) -> u32

Returns the value of late, or the default value if late is unset.

pub fn lost(&self) -> u32

Returns the value of lost, or the default value if lost is unset.

pub fn resync(&self) -> u32

Returns the value of resync, or the default value if resync is unset.

pub fn udp_packets(&self) -> u32

Returns the value of udp_packets, or the default value if udp_packets is unset.

pub fn tcp_packets(&self) -> u32

Returns the value of tcp_packets, or the default value if tcp_packets is unset.

pub fn udp_ping_avg(&self) -> f32

Returns the value of udp_ping_avg, or the default value if udp_ping_avg is unset.

pub fn udp_ping_var(&self) -> f32

Returns the value of udp_ping_var, or the default value if udp_ping_var is unset.

pub fn tcp_ping_avg(&self) -> f32

Returns the value of tcp_ping_avg, or the default value if tcp_ping_avg is unset.

pub fn tcp_ping_var(&self) -> f32

Returns the value of tcp_ping_var, or the default value if tcp_ping_var is unset.

Trait Implementations

impl Clone for Ping

fn clone(&self) -> Ping

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Ping

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

Formats the value using the given formatter.

impl Default for Ping

fn default() -> Self

Returns the “default value” for a type.

impl Message for Ping

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Ping

fn eq(&self, other: &Ping) -> 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 Copy for Ping

impl StructuralPartialEq for Ping