Struct Time 

pub struct Time { /* private fields */ }

An absolute point in time represented as nanoseconds since the UNIX epoch.

Used in DDS for sample source timestamps and other time-stamped metadata.

Implementations

impl Time

pub const NEVER: Self

A sentinel value representing a time that will never occur.

Used in DDS APIs to indicate an invalid or unset timestamp.

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

Creates a Time from a nanosecond timestamp.

Examples

use cyclonedds::Time;

let t = Time::from_nanos(1_000_000_000);

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

Creates a Time from a millisecond timestamp.

Examples

use cyclonedds::Time;

let t = Time::from_millis(1_000);

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

Creates a Time from a second timestamp.

Examples

use cyclonedds::Time;

let t = Time::from_secs(1);

pub const fn as_nanos(&self) -> i64

Returns the timestamp as nanoseconds since the UNIX epoch.

Examples

use cyclonedds::Time;

let t = Time::from_secs(1);
assert_eq!(t.as_nanos(), 1_000_000_000);

pub fn elapsed(&self) -> Result<Duration>

Returns the time elapsed since this timestamp as a Duration.

Errors

Returns Error::BadParameter if the system time cannot be converted or if this timestamp is in the future.

pub fn checked_add(&self, duration: Duration) -> Option<Self>

Adds a Duration to this time, returning None on overflow.

Examples

use cyclonedds::{Duration, Time};

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

pub fn checked_sub(&self, duration: Duration) -> Option<Self>

Subtracts a Duration from this time, returning None on underflow.

Examples

use cyclonedds::{Duration, Time};

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

Trait Implementations

impl Clone for Time

fn clone(&self) -> Time

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Time

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 Eq for Time

impl From<Time> for SystemTime

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 PartialEq for Time

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

impl TryFrom<SystemTime> for Time

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.