Struct UnixClock 

pub struct UnixClock { /* private fields */ }

A Unix OS clock

Implementations

impl UnixClock

pub const CLOCK_REALTIME: Self

The standard realtime clock on unix systems.

use clock_steering::{Clock, unix::UnixClock};

fn main() -> std::io::Result<()> {
    let clock = UnixClock::CLOCK_REALTIME;
    let now = clock.now()?;

    println!("{now:?}");

    Ok(())
}

pub const CLOCK_TAI: Self

TAI time on linux systems.

use clock_steering::{Clock, unix::UnixClock};

fn main() -> std::io::Result<()> {
    let clock = UnixClock::CLOCK_TAI;
    let now = clock.now()?;

    println!("{now:?}");

    Ok(())
}

pub fn open(path: impl AsRef<Path>) -> Result<Self>

Open a clock device.

use clock_steering::{Clock, unix::UnixClock};

fn main() -> std::io::Result<()> {
    let clock = UnixClock::open("/dev/ptp0")?;
    let now = clock.now()?;

    println!("{now:?}");

    Ok(())
}

pub fn system_offset(&self) -> Result<(Timestamp, Timestamp, Timestamp), Error>

Determine offset between file clock and TAI clock (if any) Returns two system timestamps sandwhiching a timestamp from the hardware clock.

Trait Implementations

impl Clock for UnixClock

type Error = Error

fn now(&self) -> Result<Timestamp, Self::Error>

Get the current time.

fn resolution(&self) -> Result<Timestamp, Self::Error>

Get the clock’s resolution.

fn get_frequency(&self) -> Result<f64, Self::Error>

Get the frequency of the clock The unit of the output is milliseconds (of drift) per second, compared to the “natural” frequency of the clock.

fn set_frequency(&self, frequency: f64) -> Result<Timestamp, Self::Error>

Change the frequency of the clock. Returns the time at which the change was applied.

fn step_clock(&self, offset: TimeOffset) -> Result<Timestamp, Self::Error>

Change the current time of the clock by an offset. Returns the time at which the change was applied.

fn set_leap_seconds( &self, leap_status: LeapIndicator, ) -> Result<(), Self::Error>

Change the indicators for upcoming leap seconds.

fn error_estimate_update( &self, est_error: Duration, max_error: Duration, ) -> Result<(), Self::Error>

Provide the system with the current best estimates for the statistical error of the clock, and the maximum deviation due to frequency error and distance to the root clock.

fn disable_kernel_ntp_algorithm(&self) -> Result<(), Self::Error>

Disable all standard NTP kernel clock discipline. It is all your responsibility now.

fn set_tai(&self, tai_offset: i32) -> Result<(), Error>

Set the offset between TAI and UTC.

fn get_tai(&self) -> Result<i32, Error>

Get the offset between TAI and UTC.

impl Clone for UnixClock

fn clone(&self) -> UnixClock

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UnixClock

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

Formats the value using the given formatter.

impl Copy for UnixClock