Struct mpris_server::Time

source ·

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

Expand description

A time with microsecond precision which can be negative.

Implementations§

source §

impl Time

source

pub const ZERO: Self = _

A time of zero.

Examples

use mpris_server::Time;

let time = Time::ZERO;
assert!(time.is_zero());
assert_eq!(time.as_micros(), 0);

source

pub const MIN: Self = _

The minimum time.

source

pub const MAX: Self = _

The maximum time.

source

pub const fn from_secs(secs: i64) -> Self

Creates a new Time from the specified number of whole seconds.

Examples

use mpris_server::Time;

assert_eq!(Time::from_secs(5).as_nanos(), 5_000_000_000);

source

pub const fn from_millis(millis: i64) -> Self

Creates a new Time from the specified number of whole milliseconds.

Examples

use mpris_server::Time;

assert_eq!(Time::from_millis(5).as_nanos(), 5_000_000);

source

pub const fn from_micros(micros: i64) -> Self

Creates a new Time from the specified number of whole microseconds.

Examples

use mpris_server::Time;

assert_eq!(Time::from_micros(5).as_nanos(), 5_000);

source

pub const fn from_nanos(nanos: i64) -> Self

Creates a new Time from the specified number of whole nanoseconds.

Note: This will round of the nanoseconds to microseconds level of precision.

Examples

use mpris_server::Time;

assert_eq!(Time::from_nanos(5).as_nanos(), 0);
assert_eq!(Time::from_nanos(5342).as_nanos(), 5000);

source

pub const fn as_secs(&self) -> i64

Returns the number of whole seconds contained by this Time.

Examples

use mpris_server::Time;

assert_eq!(Time::from_micros(5_000_000).as_secs(), 5);
assert_eq!(Time::from_micros(3).as_secs(), 0);

source

pub const fn as_millis(&self) -> i64

Returns the number of whole milliseconds contained by this Time.

Examples

use mpris_server::Time;

assert_eq!(Time::from_micros(5_000_000).as_millis(), 5_000);
assert_eq!(Time::from_micros(3).as_millis(), 0);

source

pub const fn as_micros(&self) -> i64

Returns the number of whole microseconds contained by this Time.

Examples

use mpris_server::Time;

assert_eq!(Time::from_micros(5_000_000).as_micros(), 5_000_000);
assert_eq!(Time::from_micros(3).as_micros(), 3);

source

pub const fn as_nanos(&self) -> i64

Returns the number of whole nanoseconds contained by this Time.

Examples

use mpris_server::Time;

assert_eq!(Time::from_micros(5_000_000).as_nanos(), 5_000_000_000);
assert_eq!(Time::from_micros(3).as_nanos(), 3_000);

source

pub const fn is_zero(&self) -> bool

Returns true if this Time is zero.

Examples

use mpris_server::Time;

assert_eq!(Time::ZERO.is_zero(), true);
assert_eq!(Time::from_micros(1).is_zero(), false);

source

pub const fn is_negative(&self) -> bool

Returns true if this Time is negative.

Examples

use mpris_server::Time;

assert_eq!(Time::ZERO.is_negative(), false);
assert_eq!(Time::from_micros(-1).is_negative(), true);
assert_eq!(Time::from_micros(1).is_negative(), false);

source

pub const fn is_positive(&self) -> bool

Returns true if this Time is positive.

Examples

use mpris_server::Time;

assert_eq!(Time::ZERO.is_positive(), false);
assert_eq!(Time::from_micros(1).is_positive(), true);
assert_eq!(Time::from_micros(-1).is_positive(), false);

source

pub const fn abs(&self) -> Self

Returns the time as an absolute (non-negative) value.

Examples

use mpris_server::Time;

assert_eq!(Time::ZERO.abs(), Time::ZERO);
assert_eq!(Time::from_micros(-1).abs(), Time::from_micros(1));
assert_eq!(Time::from_micros(1).abs(), Time::from_micros(1));

source

pub const fn checked_add(self, other: Self) -> Option<Self>

Checked Time addition. Computes self + other, returning None if overflow occurred.

Examples

use mpris_server::Time;

assert_eq!(
    Time::from_micros(1).checked_add(Time::from_micros(1)),
    Some(Time::from_micros(2))
);
assert_eq!(Time::MAX.checked_add(Time::from_micros(1)), None);

source

pub const fn checked_sub(self, other: Self) -> Option<Self>

Checked Time subtraction. Computes self - other, returning None if overflow occurred.

Examples

use mpris_server::Time;

assert_eq!(
    Time::from_micros(2).checked_sub(Time::from_micros(1)),
    Some(Time::from_micros(1))
);
assert_eq!(Time::MIN.checked_sub(Time::from_micros(1)), None);

source

pub const fn saturating_add(self, other: Self) -> Self

Saturating Time addition. Computes self + other, returning Time::MAX if overflow occurred.

Examples

use mpris_server::Time;

assert_eq!(
    Time::from_micros(1).saturating_add(Time::from_micros(1)),
    Time::from_micros(2)
);
assert_eq!(Time::MAX.saturating_add(Time::from_micros(1)), Time::MAX);

source

pub const fn saturating_sub(self, other: Self) -> Self

Saturating Time subtraction. Computes self - other, returning Time::MIN if overflow occurred.

Examples

use mpris_server::Time;

assert_eq!(
    Time::from_micros(2).saturating_sub(Time::from_micros(1)),
    Time::from_micros(1)
);
assert_eq!(Time::MIN.saturating_sub(Time::from_micros(1)), Time::MIN);