Struct ros2_client::ros2::Timestamp

pub struct Timestamp { /* private fields */ }

Representation of time instants in DDS API and RTPS protocol. Similar to std::time::Instant.

Quoting RTPS 2.3 spec 9.3.2.1:

The representation of the time is the one defined by the IETF Network Time Protocol (NTP) Standard (IETF RFC 1305). In this representation, time is expressed in seconds and fraction of seconds using the formula: time = seconds + (fraction / 2^(32))

The time origin is represented by the reserved value TIME_ZERO and corresponds to the UNIX prime epoch 0h, 1 January 1970.

Note : While NTP uses the same time representation as RTPS, it does not use the Unix epoch (1970-01-01 00:00). NTP uses the beginning of the 20th century epoch (1900-01-01 00:00) instead. So the RTPS timestamps are not interchangeable with NTP.

The timestamps will overflow in year 2106.

This type is called Time_t in the RTPS spec.

Implementations

impl Timestamp

pub const ZERO: Timestamp = _

pub const INVALID: Timestamp = _

pub const INFINITE: Timestamp = _

pub fn now() -> Timestamp

pub fn to_ticks(self) -> u64

pub fn from_ticks(ticks: u64) -> Timestamp

pub fn duration_since(&self, since: Timestamp) -> Duration

Trait Implementations

impl Add<Duration> for Timestamp

type Output = Timestamp

The resulting type after applying the + operator.

fn add(self, rhs: Duration) -> <Timestamp as Add<Duration>>::Output

Performs the + operation.

impl Clone for Timestamp

fn clone(&self) -> Timestamp

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Timestamp

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Timestamp

fn deserialize<__D>( __deserializer: __D, ) -> Result<Timestamp, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ROSTime> for Timestamp

fn from(rt: ROSTime) -> Timestamp

Converts to this type from the input type.

impl Ord for Timestamp

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

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

fn partial_cmp(&self, other: &Timestamp) -> 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<'a_, C_> Readable<'a_, C_> for Timestamp

where C_: Context,

fn read_from<R_>(_reader_: &mut R_) -> Result<Timestamp, <C_ as Context>::Error>

where R_: Reader<'a_, C_>,

fn minimum_bytes_needed() -> usize

fn read_from_buffer_with_ctx( context: C, buffer: &'a [u8], ) -> Result<Self, <C as Context>::Error>

fn read_with_length_from_buffer_with_ctx( context: C, buffer: &'a [u8], ) -> (Result<Self, <C as Context>::Error>, usize)

fn read_from_buffer_copying_data_with_ctx( context: C, buffer: &[u8], ) -> Result<Self, <C as Context>::Error>

fn read_with_length_from_buffer_copying_data_with_ctx( context: C, buffer: &[u8], ) -> (Result<Self, <C as Context>::Error>, usize)

fn read_with_length_from_buffer_copying_data_with_ctx_mut( context: &mut C, buffer: &[u8], ) -> (Result<Self, <C as Context>::Error>, usize)

fn read_from_stream_unbuffered_with_ctx<S>( context: C, stream: S, ) -> Result<Self, <C as Context>::Error>

where S: Read,

fn read_from_stream_buffered_with_ctx<S>( context: C, stream: S, ) -> Result<Self, <C as Context>::Error>

where S: Read,

fn read_from_file_with_ctx( context: C, path: impl AsRef<Path>, ) -> Result<Self, <C as Context>::Error>

impl Serialize for Timestamp

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub<Duration> for Timestamp

type Output = Timestamp

The resulting type after applying the - operator.

fn sub(self, rhs: Duration) -> <Timestamp as Sub<Duration>>::Output

Performs the - operation.

impl Sub for Timestamp

type Output = Duration

The resulting type after applying the - operator.

fn sub(self, other: Timestamp) -> Duration

Performs the - operation.

impl TryFrom<DateTime<Utc>> for Timestamp

Error from this means “out of range”

type Error = String

The type returned in the event of a conversion error.

fn try_from(ct: DateTime<Utc>) -> Result<Timestamp, String>

Performs the conversion.

impl TryFrom<Timestamp> for ROSTime

type Error = TimestampConversionError

The type returned in the event of a conversion error.

fn try_from(ts: Timestamp) -> Result<ROSTime, TimestampConversionError>

Performs the conversion.

impl<C_> Writable<C_> for Timestamp

where C_: Context,

fn write_to<T_>(&self, _writer_: &mut T_) -> Result<(), <C_ as Context>::Error>

where T_: Writer<C_> + ?Sized,

fn write_to_buffer_with_ctx( &self, context: C, buffer: &mut [u8], ) -> Result<(), <C as Context>::Error>

fn write_to_buffer_with_ctx_mut( &self, context: &mut C, buffer: &mut [u8], ) -> Result<(), <C as Context>::Error>

fn write_to_vec_with_ctx( &self, context: C, ) -> Result<Vec<u8>, <C as Context>::Error>

fn write_to_vec_with_ctx_mut( &self, context: &mut C, ) -> Result<Vec<u8>, <C as Context>::Error>

fn write_to_stream_with_ctx<S>( &self, context: C, stream: S, ) -> Result<(), <C as Context>::Error>

where S: Write,

fn write_to_file_with_ctx( &self, context: C, path: impl AsRef<Path>, ) -> Result<(), <C as Context>::Error>

fn bytes_needed(&self) -> Result<usize, <C as Context>::Error>

impl Copy for Timestamp

impl Eq for Timestamp

impl StructuralPartialEq for Timestamp