Struct statime::time::Interval

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

A log2 representation of seconds used to describe the pacing of events in PTP

Implementations

impl Interval

pub const ONE_SECOND: Self = _

An Interval of one second

pub const TWO_SECONDS: Self = _

An Interval of two seconds

pub const fn from_log_2(log_2: i8) -> Self

Construct an Interval from log2 seconds.

Example

assert_eq!(Interval::from_log_2(2).as_core_duration(), Duration::from_secs(4));
assert_eq!(Interval::from_log_2(-2).as_core_duration(), Duration::from_millis(250));

pub fn seconds(self) -> f64

Turn self into a number of seconds as f64

Example

assert_eq!(Interval::from_log_2(1).seconds(), 2.0);
assert_eq!(Interval::from_log_2(-1).seconds(), 0.5);

pub fn as_duration(self) -> Duration

Turn this into a statime::time::Duration

Example

assert_eq!(Interval::from_log_2(3).as_duration(), Duration::from_secs(8));
assert_eq!(Interval::from_log_2(-3).as_duration(), Duration::from_millis(125));

pub fn as_core_duration(self) -> Duration

Turn this into a core::time::Duration

Example

use core::time::Duration;
assert_eq!(Interval::from_log_2(3).as_core_duration(), Duration::from_secs(8));
assert_eq!(Interval::from_log_2(-3).as_core_duration(), Duration::from_millis(125));

pub fn as_log_2(self) -> i8

Get the log2 of the numbers of seconds of this Interval

Example

use core::time::Duration;
assert_eq!(Interval::ONE_SECOND.as_log_2(), 0);
assert_eq!(Interval::TWO_SECONDS.as_log_2(), 1);

Trait Implementations

impl Clone for Interval

fn clone(&self) -> Interval

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Interval

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

Formats the value using the given formatter.

impl From<i8> for Interval

fn from(value: i8) -> Self

Converts to this type from the input type.

impl Hash for Interval

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Interval

fn cmp(&self, other: &Interval) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Interval

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Interval

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for Interval

impl Eq for Interval

impl StructuralPartialEq for Interval