Struct Duration 

pub struct Duration { /* private fields */ }

A relative span of time represented as nanoseconds.

Used in DDS for timeouts, lease durations, deadlines, and other interval-based QoS policies.

Implementations

impl Duration

pub const INFINITE: Self

A sentinel value representing an infinite timeout.

Pass this to any API that accepts a Duration to block indefinitely.

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

Creates a Duration from a nanosecond value.

Unlike std::time::Duration::from_nanos, this accepts an i64 rather than a u64.

Examples

use cyclonedds::Duration;

let d = Duration::from_nanos(1_000_000);

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

Creates a Duration from a millisecond value.

Examples

use cyclonedds::Duration;

let d = Duration::from_millis(100);

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

Creates a Duration from a second value.

Examples

use cyclonedds::Duration;

let d = Duration::from_secs(5);

pub const fn as_nanos(&self) -> i64

Returns the duration in nanoseconds.

Examples

use cyclonedds::Duration;

assert_eq!(Duration::from_secs(1).as_nanos(), 1_000_000_000);

pub const fn as_millis(&self) -> i64

Returns the duration in whole milliseconds.

Examples

use cyclonedds::Duration;

assert_eq!(Duration::from_secs(1).as_millis(), 1_000);

pub const fn as_secs(&self) -> i64

Returns the duration in whole seconds.

Examples

use cyclonedds::Duration;

assert_eq!(Duration::from_millis(1_500).as_secs(), 1);

pub const fn is_infinite(&self) -> bool

Returns true if this duration equals Duration::INFINITE.

Examples

use cyclonedds::Duration;

assert!(Duration::INFINITE.is_infinite());
assert!(!Duration::from_secs(5).is_infinite());

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

Adds two durations, returning None on overflow.

Examples

use cyclonedds::Duration;

let d = Duration::from_secs(1).checked_add(Duration::from_secs(2));
assert_eq!(d, Some(Duration::from_secs(3)));

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

Subtracts a duration, returning None on underflow.

Examples

use cyclonedds::Duration;

let d = Duration::from_secs(3).checked_sub(Duration::from_secs(1));
assert_eq!(d, Some(Duration::from_secs(2)));

pub fn checked_mul(self, rhs: i64) -> Option<Self>

Multiplies a duration by a scalar, returning None on overflow.

Examples

use cyclonedds::Duration;

let d = Duration::from_secs(2).checked_mul(3);
assert_eq!(d, Some(Duration::from_secs(6)));

Trait Implementations

impl Add for Duration

fn add(self, rhs: Self) -> Self::Output

Adds two durations.

Panics

Panics on overflow. Use checked_add for a non-panicking alternative.

type Output = Duration

The resulting type after applying the + operator.

impl Clone for Duration

fn clone(&self) -> Duration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Duration

impl Debug for Duration

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

Formats the value using the given formatter.

impl Default for Duration

fn default() -> Duration

Returns the “default value” for a type.

impl Eq for Duration

impl From<Duration> for Duration

fn from(duration: Duration) -> Self

Converts to this type from the input type.

impl Hash for Duration

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 Mul<i64> for Duration

fn mul(self, rhs: i64) -> Self::Output

Multiplies a duration by a scalar.

Panics

Panics on overflow. Use checked_mul for a non-panicking alternative.

type Output = Duration

The resulting type after applying the * operator.

impl PartialEq for Duration

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

impl Sub for Duration

fn sub(self, rhs: Self) -> Self::Output

Subtracts a duration.

Panics

Panics on underflow. Use checked_sub for a non-panicking alternative.

type Output = Duration

The resulting type after applying the - operator.

impl TryFrom<Duration> for Duration

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Duration) -> Result<Self, Self::Error>

Performs the conversion.