Struct Timestamp

#[repr(transparent)]
pub struct Timestamp<T = u64>(pub T);

Timestamp is a generic implementation of a type that represents some point in time.

Usage

Examples

Example #1 Using the now method to get the current timestamp

#[cfg(feature = "std")]
let ts = scsys_core::Timestamp::<u64>::now();

Features

The timestamps implementation dynamically reflects the extensive feature-gating of the crate. Listed below are the features that customize the behavior of the Timestamp type:

• serde: Enables serialization and deserialization of the Timestamp type.

• chrono: Enables support for chrono timestamps, uses i64 for the Now impl

• std: Enables the use of system time for the default implementation of:

  • Timestamp<u64>: for seconds
  • Timestamp<u128>: for milliseconds

Tuple Fields

0: T

Implementations

impl<T> Timestamp<T>

where T: RawTimestamp,

pub fn new(ts: T) -> Self

create a new instance of Timestamp with the given value.

pub fn now() -> Self

where Self: Now<Output = Self>,

a convenience method to create a new Timestamp instance with the current time.

pub const fn get(&self) -> &T

Get an immutable reference to the current timestamp.

pub const fn get_mut(&mut self) -> &mut T

Get a mutable reference to the current timestamp.

pub fn value(self) -> T

consumes the current instance and returns the inner value.

pub const fn replace(&mut self, value: T) -> T

replace the current value with a new one and return the old one

pub fn set(&mut self, ts: T) -> &mut Self

update the current value and return a mutable reference to the current instance.

pub const fn swap(&mut self, ts: &mut T)

swap the current value with another and return a mutable reference to self

pub fn take(&mut self) -> T

where T: Default,

take the current value and return it, leaving the logical default in its place.

pub fn with<U: RawTimestamp>(self, ts: U) -> Timestamp<U>

consumes the current instance to create another with the given value

pub fn map<U, F>(self, f: F) -> Timestamp<U>

where F: FnOnce(T) -> U, U: RawTimestamp,

applies a function onto the current value and returns a new instance with the result

pub fn map_inplace<F>(&mut self, f: F) -> &mut Self

where F: FnOnce(&mut T),

returns a new instance of the Timestamp with the current value updated using the given function

pub fn update(&mut self) -> T

where T: Now<Output = T>,

updates the timestamp to reflect now and return the previous timestamp

pub const fn view(&self) -> Timestamp<&T>

returns a new instance of the Timestamp containing an immutable reference to the inner value.

pub const fn view_mut(&mut self) -> Timestamp<&mut T>

returns a new instance of the Timestamp containing a mutable reference to the inner value.

impl<T> Timestamp<T>

where T: RawTimestamp,

pub fn as_ref(&self) -> &T

👎Deprecated since 0.2.8: use Timestamp::get instead

pub fn as_mut(&mut self) -> &mut T

👎Deprecated since 0.2.8: use Timestamp::get_mut instead

pub fn into_inner(self) -> T

👎Deprecated since 0.2.8: use Timestamp::value instead

Trait Implementations

impl<T: RawTimestamp> AsMut<T> for Timestamp<T>

fn as_mut(&mut self) -> &mut T

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

impl<T: RawTimestamp> AsRef<T> for Timestamp<T>

fn as_ref(&self) -> &T

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

impl<T> Binary for Timestamp<T>

where T: Binary,

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

Formats the value using the given formatter.

impl<T: RawTimestamp> Borrow<T> for Timestamp<T>

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<T: RawTimestamp> BorrowMut<T> for Timestamp<T>

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value.

impl<T: Clone> Clone for Timestamp<T>

fn clone(&self) -> Timestamp<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Timestamp<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Default for Timestamp<T>

where Self: Now<Output = Self>, T: RawTimestamp,

fn default() -> Self

Returns the “default value” for a type.

impl<T: RawTimestamp> Deref for Timestamp<T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T: RawTimestamp> DerefMut for Timestamp<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

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

where T: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Display for Timestamp<T>

where T: Display,

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

Formats the value using the given formatter.

impl<Tz> From<DateTime<Tz>> for Timestamp<i64>

where Tz: TimeZone,

fn from(ts: DateTime<Tz>) -> Self

Converts to this type from the input type.

impl From<Duration> for Timestamp<u64>

fn from(dur: Duration) -> Self

Converts to this type from the input type.

impl From<Duration> for Timestamp<u128>

fn from(dur: Duration) -> Self

Converts to this type from the input type.

impl From<Timestamp<u128>> for Duration

fn from(ts: Timestamp<u128>) -> Self

Converts to this type from the input type.

impl From<Timestamp> for Duration

fn from(ts: Timestamp<u64>) -> Self

Converts to this type from the input type.

impl<T: Hash> Hash for Timestamp<T>

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<T> LowerExp for Timestamp<T>

where T: LowerExp,

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

Formats the value using the given formatter.

impl<T> LowerHex for Timestamp<T>

where T: LowerHex,

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

Formats the value using the given formatter.

impl Now for Timestamp<u64>

type Output = Timestamp

fn now() -> Self::Output

impl Now for Timestamp<i64>

type Output = Timestamp<i64>

fn now() -> Self::Output

impl Now for Timestamp<u128>

type Output = Timestamp<u128>

fn now() -> Self::Output

impl<T> Octal for Timestamp<T>

where T: Octal,

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

Formats the value using the given formatter.

impl<T: Ord> Ord for Timestamp<T>

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

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

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

where T: Pointer,

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

Formats the value using the given formatter.

impl<T> Serialize for Timestamp<T>

where T: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> UpperExp for Timestamp<T>

where T: UpperExp,

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

Formats the value using the given formatter.

impl<T> UpperHex for Timestamp<T>

where T: UpperHex,

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

Formats the value using the given formatter.

impl<T: Copy> Copy for Timestamp<T>

impl<T: Eq> Eq for Timestamp<T>

impl<T> StructuralPartialEq for Timestamp<T>