Struct Timestamp 

pub struct Timestamp { /* private fields */ }

A timestamp as they occur in PTP messages.

This is a number of seconds and nanoseconds since the epoch of the timescale in use. For the PTP timescale the epoch is 00:00:00TAI on January 1, 1970.

Implementations

impl Timestamp

pub fn new(seconds: u64, nanos: u32) -> Result<Self, Error>

Try to create a new timestamp with the given number of seconds and nanoseconds since the epoch.

Errors

This function fails if the number of seconds is larger than or equal to 2^48, or when the number of nanoseconds represents more than a whole second.

pub fn seconds(self) -> u64

The number of whole seconds passed since the epoch.

pub fn nanos(self) -> u32

The number of nanoseconds passed in addition to the whole seconds.

pub fn try_set_seconds(&mut self, seconds: u64) -> Result<(), Error>

Update the whole number of seconds since the epoch.

Errors

This fails when the number of seconds is larger than or eque

pub fn try_set_nanos(&mut self, nanos: u32) -> Result<(), Error>

Update the number of nanoseconds passed.

Errors

This fails when the number of nanoseconds is larger than a whole second.

pub fn serialize(self, buffer: &mut [u8]) -> Result<(), Error>

Serialize the timestmap to the provided buffer (expected to be 10 bytes long).

Errors

Fails when the provided buffer is too short.

pub fn deserialize(buffer: &[u8]) -> Result<Self, Error>

Deserialize the timestamp from the provided buffer (expected to be 10 bytes long).

Errors

Fails when the provided buffer is too short, or when the number of nanoseconds encoded in the buffer is outside of the interval [0, 1000000000).

Trait Implementations

impl Clone for Timestamp

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Timestamp

impl Debug for Timestamp

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

Formats the value using the given formatter.

impl Default for Timestamp

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Timestamp

impl From<Timestamp> for Timestamp<TAI>

fn from(value: Timestamp) -> Self

Converts to this type from the input type.

impl Ord for Timestamp

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Timestamp

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Timestamp

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralPartialEq for Timestamp

impl TryFrom<Timestamp<TAI>> for Timestamp

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Timestamp<TAI>) -> Result<Self, Self::Error>

Performs the conversion.