Struct hyparview::TimeToLive

pub struct TimeToLive(_);

TTL of a message.

It decreases by one each time the message is forwarded. If the TTL of a message reaches zero, the message will be handled by the node that keeps the message at the time. So, a TTL can be regarded as the hop count of a message.

Methods

impl TimeToLive

pub fn new(ttl: u8) -> Self

Makes a new TimeToLive instance.

pub fn as_u8(self) -> u8

Returns the value of the TTL.

pub fn is_expired(self) -> bool

Returns true if the TTL is expired, otherwise false.

Examples

use hyparview::TimeToLive;

let ttl = TimeToLive::new(10);
assert!(!ttl.is_expired());

let ttl = TimeToLive::new(0);
assert!(ttl.is_expired());

Trait Implementations

impl Eq for TimeToLive

impl Clone for TimeToLive

fn clone(&self) -> TimeToLive

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for TimeToLive

impl PartialOrd<TimeToLive> for TimeToLive

fn partial_cmp(&self, other: &TimeToLive) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &TimeToLive) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &TimeToLive) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &TimeToLive) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &TimeToLive) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialEq<TimeToLive> for TimeToLive

fn eq(&self, other: &TimeToLive) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Ord for TimeToLive

fn cmp(&self, other: &TimeToLive) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

impl Hash for TimeToLive

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, 

Feeds a slice of this type into the given [Hasher].

impl Debug for TimeToLive

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

Formats the value using the given formatter.