Struct Subseconds 

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

A subsecond value as produced by the PTP peripheral

Implementations

impl Subseconds

pub const MAX_VALUE: u32 = 2_147_483_647u32

The maximum possible value for Subseconds

pub const MAX: Self

The maximum possible Subseconds

pub const ZERO: Self

Zero Subseconds

pub const fn new(value: u32) -> Option<Self>

Create a new Subseconds from the provided value.

The returned Subseconds represents a time of value / 2^31 seconds.

To obtain that representation in nanoseconds, see Subseconds::nanos.

To approximate a Subseconds from nanoseconds, see Subseconds::new_from_nanos.

Returns None if value > SUBSECONDS_PER_SECOND. (See SUBSECONDS_PER_SECOND).

pub const fn new_from_nanos(nanos: u32) -> Option<Self>

Create a new Subseconds from the given amount of nanoseconds, using a round-to-nearest method.

Returns None if nanos >= NANOS_PER_SECOND. (See NANOS_PER_SECOND)

pub const fn nanos(&self) -> u32

Convert this Subseconds to nanoseconds, using a round-to-nearest method.

pub const fn raw(&self) -> u32

Get the raw value of this Subseconds

Trait Implementations

impl Add for Subseconds

type Output = Subseconds

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for Subseconds

fn add_assign(&mut self, rhs: Subseconds)

Performs the += operation.

impl Clone for Subseconds

fn clone(&self) -> Subseconds

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Subseconds

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

Formats the value using the given formatter.

impl Format for Subseconds

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

Writes the defmt representation of self to fmt.

impl Ord for Subseconds

fn cmp(&self, other: &Subseconds) -> 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.

impl PartialEq for Subseconds

fn eq(&self, other: &Subseconds) -> 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 PartialOrd for Subseconds

fn partial_cmp(&self, other: &Subseconds) -> 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 Sub for Subseconds

type Output = Subseconds

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for Subseconds

fn sub_assign(&mut self, rhs: Subseconds)

Performs the -= operation.

impl Copy for Subseconds

impl Eq for Subseconds

impl StructuralPartialEq for Subseconds