Struct Timestamp

pub struct Timestamp(/* private fields */);

A timestamp produced by the PTP periperhal

Implementations

impl Timestamp

pub const fn new(negative: bool, seconds: u32, subseconds: Subseconds) -> Self

Create a new Timestamp

pub const fn new_raw(value: i64) -> Self

Create a new Timestamp from the given raw value.

pub const fn raw(&self) -> i64

Get the raw value of this Timestamp

pub const fn is_negative(&self) -> bool

Check whether this timestamp is negative or not.

pub const fn is_positive(&self) -> bool

Check whether this timestamp is positive or not.

pub const fn seconds(&self) -> u32

Get the second component of this timestamp

pub const fn subseconds(&self) -> Subseconds

Get the raw subsecond value of this timestamp.

pub const fn subseconds_signed(&self) -> u32

Get the signed subsecond value of this timestamp.

Note that this is not an i32: it is, technically, a u31 with a leading sign bit.

pub const fn nanos(&self) -> u32

Get the nanosecond component of this timestamp

pub const fn total_nanos(&self) -> i64

Get the total amount of nanoseconds in this Timestamp.

Example:

let timestamp = Timestamp::new(false, 500, Subseconds::new_from_nanos(500_000).unwrap());
assert_eq!(timestamp.total_nanos(), 500 * 1_000_000_000 + 500_000);


let timestamp_neg = Timestamp::new(true, 500, Subseconds::new_from_nanos(500_000).unwrap());
assert_eq!(timestamp_neg.total_nanos(), -1 * (500 * 1_000_000_000 + 500_000));

pub const fn from_parts(high: u32, low: u32) -> Timestamp

Create a new timestamp from the provided register values.

pub fn from_descriptor(desc: &Descriptor) -> Option<Self>

Create a timestamp from the given descriptor

Trait Implementations

impl Add for Timestamp

type Output = Timestamp

The resulting type after applying the + operator.

fn add(self, rhs: Timestamp) -> Self::Output

Performs the + operation.

impl AddAssign for Timestamp

fn add_assign(&mut self, rhs: Timestamp)

Performs the += operation.

impl Clone for Timestamp

fn clone(&self) -> Timestamp

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Timestamp

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

Formats the value using the given formatter.

impl Format for Timestamp

fn format(&self, fmt: Formatter<'_>)

Writes the defmt representation of self to fmt.

impl PartialEq for Timestamp

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Sub for Timestamp

type Output = Timestamp

The resulting type after applying the - operator.

fn sub(self, rhs: Timestamp) -> Self::Output

Performs the - operation.

impl SubAssign for Timestamp

fn sub_assign(&mut self, rhs: Timestamp)

Performs the -= operation.

impl Copy for Timestamp

impl Eq for Timestamp

impl StructuralPartialEq for Timestamp