Struct Duration_type

pub struct Duration_type { /* private fields */ }

Represents a duration of time.

A duration is the amount of time between two instants. It can only be positive. Its maximum precision is nanoseconds. It is deeply inspired by the core::time::Duration type.

Implementations

impl Duration_type

pub const fn New(Seconds: u64, Nanoseconds: u32) -> Self

Creates a new Duration_type from the specified number of seconds and nanoseconds.

pub fn Get_duration_since(&self, Earlier: &Duration_type) -> Duration_type

Returns the duration between the two instants.

Example

use Shared::Duration_type;

let earlier = Duration_type::New(1, 0);
let later = Duration_type::New(2, 0);

let duration = later.Get_duration_since(&earlier);

assert_eq!(duration, Duration_type::New(1, 0));

let duration = earlier.Get_duration_since(&later);
assert_eq!(duration, Duration_type::New(0, 0));

pub fn Get_duration_since_checked( &self, Earlier: &Duration_type, ) -> Option<Duration_type>

Returns the duration between the two instants, or None if the duration is negative.

Example

use Shared::Duration_type;

let earlier = Duration_type::New(1, 0);
let later = Duration_type::New(2, 0);

let duration = later.Get_duration_since_checked(&earlier);
assert_eq!(duration, Some(Duration_type::New(1, 0)));

let duration = earlier.Get_duration_since_checked(&later);
assert_eq!(duration, None);

pub fn Get_duration_since_saturating( &self, earlier: &Duration_type, ) -> Duration_type

Returns the duration between the two instants, saturating at the bounds of the type.

Example

use Shared::Duration_type;

let earlier = Duration_type::New(1, 0);
let later = Duration_type::New(2, 0);

let duration = later.Get_duration_since_saturating(&earlier);
assert_eq!(duration, Duration_type::New(1, 0));

let duration = earlier.Get_duration_since_saturating(&later);
assert_eq!(duration, Duration_type::default());

pub fn Add_checked(&self, Duration: &Duration_type) -> Option<Duration_type>

pub fn Substract_checked( &self, Duration: &Duration_type, ) -> Option<Duration_type>

pub fn Add_saturating(&self, Duration: &Duration_type) -> Duration_type

pub fn Substract_saturating(&self, duration: &Duration_type) -> Duration_type

pub fn As_seconds(&self) -> u64

Returns the number of seconds in the duration.

Example

use Shared::Duration_type;

let duration = Duration_type::New(1, 500_000_000);
assert_eq!(duration.As_seconds(), 1);

pub fn As_milliseconds(&self) -> u64

Returns the number of milliseconds in the duration.

Example

use Shared::Duration_type;

let duration = Duration_type::New(1, 500_000_000);
assert_eq!(duration.As_milliseconds(), 1_500);

pub fn As_microseconds(&self) -> u128

Returns the number of microseconds in the duration.

Example

use Shared::Duration_type;

let duration = Duration_type::New(1, 500_000_000);

assert_eq!(duration.As_microseconds(), 1_500_000);

pub fn As_nanoseconds(&self) -> u128

Returns the number of nanoseconds in the duration.

Example

use Shared::Duration_type;

let duration = Duration_type::New(1, 500_000_000);
assert_eq!(duration.As_nanoseconds(), 1_500_000_000);

Trait Implementations

impl Add<&Duration_type> for Duration_type

type Output = Duration_type

The resulting type after applying the + operator.

fn add(self, Duration: &Duration_type) -> Duration_type

Performs the + operation.

impl AddAssign<&Duration_type> for Duration_type

fn add_assign(&mut self, Duration: &Duration_type)

Performs the += operation.

impl AsMut<[u8]> for Duration_type

fn as_mut(&mut self) -> &mut [u8]

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<[u8]> for Duration_type

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Duration_type

fn clone(&self) -> Duration_type

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Duration_type

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

Formats the value using the given formatter.

impl Default for Duration_type

fn default() -> Duration_type

Returns the “default value” for a type.

impl Hash for Duration_type

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 Duration_type

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

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

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

type Output = Duration_type

The resulting type after applying the - operator.

fn sub(self, Duration: &Duration_type) -> Duration_type

Performs the - operation.

impl SubAssign<&Duration_type> for Duration_type

fn sub_assign(&mut self, Duration: &Duration_type)

Performs the -= operation.

impl Eq for Duration_type

impl StructuralPartialEq for Duration_type