Struct mpris_server::Time

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

A time with microsecond precision which can be negative.

Implementations

impl Time

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);

pub const MIN: Self = _

The minimum time.

pub const MAX: Self = _

The maximum time.

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

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

Panics

This will panic if the number of seconds overflows.

Examples

use mpris_server::Time;

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

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

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

Panics

This will panic if the number of milliseconds overflows.

Examples

use mpris_server::Time;

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

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);

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);

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);

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);

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);

pub const fn as_nanos(&self) -> i128

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);

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);

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);

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);

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));

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);

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);

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);

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);

Trait Implementations

impl Add for Time

type Output = Time

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for Time

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for Time

fn clone(&self) -> Time

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Time

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

Formats the value using the given formatter.

impl Default for Time

fn default() -> Time

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Time

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> From<Time> for Value<'a>

fn from(time: Time) -> Self

Converts to this type from the input type.

impl Hash for Time

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 Time

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

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

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for Time

type Output = Time

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for Time

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl TryFrom<&Value<'_>> for Time

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &Value<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value<'_>> for Time

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl Type for Time

fn signature() -> Signature<'static>

Get the signature for the implementing type.

impl Copy for Time

impl Eq for Time

impl StructuralPartialEq for Time