Struct plumtree::time::Clock

pub struct Clock(_);

Node local clock.

Each Node has a clock instance. When a node is created, the time of its clock is initialized to zero. Then each time Clock::tick method is called, the time of the clock proceeds by the specified duration.

Methods

impl Clock

pub fn new() -> Self

Makes a new Clock instance.

Examples

use plumtree::time::Clock;
use std::time::Duration;

assert_eq!(Clock::new().now().as_duration(), Duration::from_secs(0));

pub fn now(&self) -> NodeTime

Returns the current time of the clock.

Examples

use plumtree::time::Clock;
use std::time::Duration;

let mut clock = Clock::new();
assert_eq!(clock.now().as_duration(), Duration::from_secs(0));

clock.tick(Duration::from_secs(100));
assert_eq!(clock.now().as_duration(), Duration::from_secs(100));

pub fn tick(&mut self, duration: Duration)

Proceeds the time of the clock by the given duration.

Trait Implementations

impl Debug for Clock

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

Formats the value using the given formatter.

impl Default for Clock

fn default() -> Clock

Returns the "default value" for a type.

impl Clone for Clock

fn clone(&self) -> Clock

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq for Clock

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

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

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

This method tests for !=.

impl Eq for Clock

impl Hash for Clock

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 PartialOrd for Clock

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

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

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

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

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

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

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

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

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

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

impl Ord for Clock

fn cmp(&self, other: &Clock) -> 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.