Struct sirpent::utils::Milliseconds

pub struct Milliseconds { /* fields omitted */ }

Represents a duration in milliseconds.

Methods

impl Milliseconds

fn new(milliseconds: u64) -> Milliseconds

fn millis(&self) -> u64

Methods from Deref<Target=Duration>

fn as_secs(&self) -> u64

Returns the number of whole seconds represented by this Duration.

The extra precision represented by this duration is ignored (i.e. extra nanoseconds are not represented in the returned value).

Examples

use std::time::Duration;

let five_seconds = Duration::new(5, 0);
assert_eq!(five_seconds.as_secs(), 5);

fn subsec_nanos(&self) -> u32

Returns the nanosecond precision represented by this Duration.

This method does not return the length of the duration when represented by nanoseconds. The returned number always represents a fractional portion of a second (i.e. it is less than one billion).

Examples

use std::time::Duration;

let duration = Duration::from_millis(5010);
assert_eq!(duration.subsec_nanos(), 10000000);

fn checked_add(self, rhs: Duration) -> Option<Duration>

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

Examples

Basic usage:

use std::time::Duration;

assert_eq!(Duration::new(0, 0).checked_add(Duration::new(0, 1)), Some(Duration::new(0, 1)));
assert_eq!(Duration::new(1, 0).checked_add(Duration::new(std::u64::MAX, 0)), None);

fn checked_sub(self, rhs: Duration) -> Option<Duration>

Checked Duration subtraction. Computes self - other, returning None if the result would be negative or if underflow occurred.

Examples

Basic usage:

use std::time::Duration;

assert_eq!(Duration::new(0, 1).checked_sub(Duration::new(0, 0)), Some(Duration::new(0, 1)));
assert_eq!(Duration::new(0, 0).checked_sub(Duration::new(0, 1)), None);

fn checked_mul(self, rhs: u32) -> Option<Duration>

Checked Duration multiplication. Computes self * other, returning None if overflow occurred.

Examples

Basic usage:

use std::time::Duration;

assert_eq!(Duration::new(0, 500_000_001).checked_mul(2), Some(Duration::new(1, 2)));
assert_eq!(Duration::new(std::u64::MAX - 1, 0).checked_mul(2), None);

fn checked_div(self, rhs: u32) -> Option<Duration>

Checked Duration division. Computes self / other, returning None if other == 0.

Examples

Basic usage:

use std::time::Duration;

assert_eq!(Duration::new(2, 0).checked_div(2), Some(Duration::new(1, 0)));
assert_eq!(Duration::new(1, 0).checked_div(2), Some(Duration::new(0, 500_000_000)));
assert_eq!(Duration::new(2, 0).checked_div(0), None);

Trait Implementations

impl PartialEq for Milliseconds

fn eq(&self, __arg_0: &Milliseconds) -> bool

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

fn ne(&self, __arg_0: &Milliseconds) -> bool

This method tests for !=.

impl Clone for Milliseconds

fn clone(&self) -> Milliseconds

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Milliseconds

impl Debug for Milliseconds

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Deref for Milliseconds

type Target = Duration

The resulting type after dereferencing

fn deref(&self) -> &Self::Target

The method called to dereference a value

impl Into<Duration> for Milliseconds

fn into(self) -> Duration

Performs the conversion.

impl Serialize for Milliseconds

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where S: Serializer

Serialize this value into the given Serde serializer.

impl Deserialize for Milliseconds

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where D: Deserializer

Deserialize this value from the given Serde deserializer.