Struct byztime::ConsumerContext

pub struct ConsumerContext { /* fields omitted */ }

Provides a read-only interface to a timedata file

Implementations

impl ConsumerContext

pub fn open(path: &Path) -> Result<ConsumerContext>

Open a timedata file for read-only access

Trait Implementations

impl Context for ConsumerContext

fn as_mut_ptr(&self) -> *mut byztime_ctx

Return a raw pointer to the underlying byztime_sys::byztime_ctx.

fn close(self) -> Result<()>

Close the timedata file. Calling this function rather than simply dropping the Context object allows graceful handling of disk failures or other I/O errors that emerge while closing the file. (The Drop instance handles such errors by panicking).

fn offset(&self) -> Result<(Timestamp, Timestamp, Timestamp)>

Look up the current estimated offset (global clock - local clock) and error bounds and return it as (min, est, max).

fn global_time(&self) -> Result<(Timestamp, Timestamp, Timestamp)>

Look up the current global time and error bounds and return them as (min, est, max).

fn get_drift(&self) -> i64

Return the drift rate, in parts per billion, that offset and global_time use in their error bound calculations.

fn set_drift(&self, drift_ppb: i64)

Set the drift rate, in parts per billion, for offset and global_time to use in their error bound calculations.

fn slew(
    &self,
    min_rate_ppb: i64,
    max_rate_ppb: i64,
    max_error: Option<Timestamp>
) -> Result<()>

Begin slewing time estimates.

fn step(&self) -> Result<()>

Go back into step mode following a previous call to slew.

impl Drop for ConsumerContext

fn drop(&mut self)

Executes the destructor for this type.

impl Send for ConsumerContext

impl Sync for ConsumerContext