Struct PersistedClock 

pub struct PersistedClock { /* private fields */ }

A Clock implementation, that can be persisted to disk, via the from_path or save_to_file functions.

Implementations

impl PersistedClock

pub fn new(path: PathBuf) -> Result<Self, Error>

Create a new PersistedClock. This will override the contents of path. If you want to re-load a previously persisted clock, use PersistedClock::from_path.

Errors

If the path cannot be opened for writing.

pub fn from_path(path: PathBuf) -> Result<Self, Error>

Loads this clock from a previously persisted clock.

Errors

If the path cannot be opened for reading and writing.

pub fn save_to_file(&mut self, create: bool) -> Result<(), Error>

Save this clock to disk.

Note

The file needs to be opened in read-write mode, because we check that the file’s content reflect our clock value.

Errors

If the IO operations fail.

Panics

If our time is behind the files stored time.

Trait Implementations

impl Clock for PersistedClock

type IncrementError = Error

The Error returned, when trying to increment this clock.

type WitnessError = Error

The Error returned, when trying to witness this clock.

fn time(&self) -> Time

Get the current value of this clock.

fn increment(&mut self) -> Result<Time, Self::IncrementError>

Return the current value and increment it internally.

fn witness(&mut self, time: Time) -> Result<(), Self::WitnessError>

Update our clock based on another processes clock’s value, we “witnessed”.

impl Debug for PersistedClock

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

Formats the value using the given formatter.