Struct utcnow::UtcTime

pub struct UtcTime { /* private fields */ }

A Unix time, i.e. seconds since 1970-01-01 in UTC

Using i64 values as seconds since 1970-01-01, this library will work for the next 292 billion years.

Implementations

impl UtcTime

pub const EPOCH: UtcTime = _

Start of the Unix time epoch, 1970-01-01.

pub fn now() -> Result<Self>

Get the current time

This method does the same as calling utcnow().

Errors

See utcnow() for further information.

Example

let now = UtcTime::now().unwrap();
let seconds = now.as_secs();
let nanos = now.subsec_nanos();

pub const unsafe fn new_unchecked(secs: i64, nanos: u32) -> Self

Build a new UtcTime without normalization

If the value for nanos exceeds 1_000_000_000, your program is malformed. Expect undefined behavior!

Safety

Expect random and impossible to debug runtime errors if the input is not in range.

pub const fn new(secs: i64, nanos: u32) -> Option<Self>

Build a new UtcTime

nanos will be normalized to a values less than 1_000_000_000, the number of nanoseconds in a second. If the resulting number of seconds will exceed i64::MAX, None is returned.

Example

// August 3, 2022, about 19 o'clock in the evening in CEST.
let timestamp = UtcTime::new(1_659_545_693, 895_531_827).unwrap();

pub fn from_system_time(value: SystemTime) -> Option<Self>

Available on crate feature std only.

Convert a SystemTime

Example

let system_time = SystemTime::now();
let now = UtcTime::from_system_time(system_time).unwrap();

pub const fn from_duration(value: Duration) -> Option<Self>

Convert a Duration

The duration is interpreted as seconds since epoch (1970-01-01 in UTC).

Example

let duration = Duration::from_secs(42);
let timestamp = UtcTime::from_duration(duration).unwrap();
assert_eq!(timestamp.as_nanos(), 42_000_000_000);

pub const fn as_secs(self) -> i64

Total number of whole seconds since epoch (1970-01-01 in UTC)

Example

let now = UtcTime::now().unwrap();
let total_secs = now.as_secs();
assert!(total_secs > 1_658_711_810);
assert!(total_secs < 1_974_324_043); // update before 2032-07-25

pub const fn as_millis(self) -> i128

Total number of whole milliseconds since epoch (1970-01-01 in UTC)

Example

let now = UtcTime::now().unwrap();
let total_millis = now.as_millis();
assert!(total_millis > 1_658_711_810_802);
assert!(total_millis < 1_974_324_043_000); // update before 2032-07-25

pub const fn as_micros(self) -> i128

Total number of whole microseconds since epoch (1970-01-01 in UTC)

Example

let now = UtcTime::now().unwrap();
let total_micros = now.as_micros();
assert!(total_micros > 1_658_711_810_802_520);
assert!(total_micros < 1_974_324_043_000_000); // update before 2032-07-25

pub const fn as_nanos(self) -> i128

Total number of whole nanoseconds since epoch (1970-01-01 in UTC)

Example

let now = UtcTime::now().unwrap();
let total_nanos = now.as_nanos();
assert!(total_nanos > 1_658_711_810_802_520_027);
assert!(total_nanos < 1_974_324_043_000_000_000); // update before 2032-07-25

pub const fn subsec_millis(self) -> u32

Fractional number of milliseconds since epoch (1970-01-01 in UTC)

Example

let now = UtcTime::now().unwrap();
let millis = now.subsec_millis();
assert!(millis < 1_000);

pub const fn subsec_micros(self) -> u32

Fractional number of microseconds since epoch (1970-01-01 in UTC)

Example

let now = UtcTime::now().unwrap();
let micros = now.subsec_micros();
assert!(micros < 1_000_000);

pub const fn subsec_nanos(self) -> u32

Fractional number of nanoseconds since epoch (1970-01-01 in UTC)

Example

let now = UtcTime::now().unwrap();
let nanos = now.subsec_nanos();
assert!(nanos < 1_000_000_000);

pub const fn into_duration(self) -> Result<Duration, ConversionError>

Convert the timestamp to a Duration since epoch (1970-01-01 in UTC)

Errors

Fails if the timestamp lies before 1970-01-01 in UTC.

Example

let now = UtcTime::now().unwrap();
let duration = now.into_duration().unwrap();

pub fn into_system_time(self) -> Result<SystemTime, ConversionError>

Available on crate feature std only.

Convert the timestamp to a SystemTime

Errors

The conversion won’t succeed if and only if the stored date is earlier than 1970-01-01.

Example

let now = UtcTime::now().unwrap();
let system_time = now.into_system_time().unwrap();

Trait Implementations

impl<'a> Arbitrary<'a> for UtcTime

Available on crate feature arbitrary only.

fn arbitrary(u: &mut Unstructured<'a>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

impl Arbitrary for UtcTime

Available on crate feature quickcheck only.

fn arbitrary(gen: &mut Gen) -> Self

Return an arbitrary value.

fn shrink(&self) -> Box<dyn Iterator<Item = Self>>

Return an iterator of values that are smaller than itself.

impl Arbitrary for UtcTime

Available on crate feature proptest only.

type Parameters = <(i64, u32) as Arbitrary>::Parameters

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

type Strategy = Map<<(i64, u32) as Arbitrary>::Strategy, fn(_: (i64, u32)) -> UtcTime>

The type of Strategy used to generate values of type Self.

fn arbitrary_with(args: Self::Parameters) -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl Archive for UtcTime

Available on crate feature rkyv only.

type Archived = ArchivedUtcTime

The archived representation of this type.

type Resolver = UtcTimeResolver

The resolver for this type. It must contain all the additional information from serializing needed to make the archived type from the normal type.

unsafe fn resolve( &self, pos: usize, resolver: Self::Resolver, out: *mut Self::Archived )

Creates the archived version of this value at the given position and writes it to the given output.

impl Clone for UtcTime

fn clone(&self) -> UtcTime

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UtcTime

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

Formats the value using the given formatter.

impl Default for UtcTime

fn default() -> UtcTime

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for UtcTime

Available on crate feature serde only.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<D: Fallible + ?Sized> Deserialize<UtcTime, D> for Archived<UtcTime>

Available on crate feature rkyv only.

fn deserialize(&self, deserializer: &mut D) -> Result<UtcTime, D::Error>

Deserializes using the given deserializer

impl Display for UtcTime

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

Formats the value using the given formatter.

impl FromStr for UtcTime

type Err = ConversionError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for UtcTime

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 UtcTime

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

fn eq(&self, other: &UtcTime) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for UtcTime

fn partial_cmp(&self, other: &UtcTime) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<S: Fallible + ?Sized> Serialize<S> for UtcTime

Available on crate feature rkyv only.

fn serialize(&self, serializer: &mut S) -> Result<Self::Resolver, S::Error>

Writes the dependencies for the object and returns a resolver that can create the archived type.

impl Serialize for UtcTime

Available on crate feature serde only.

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for UtcTime

type Error = ConversionError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Duration> for UtcTime

type Error = ConversionError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<SystemTime> for UtcTime

Available on crate feature std only.

type Error = ConversionError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<UtcTime> for Duration

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: UtcTime) -> Result<Self, ConversionError>

Performs the conversion.

impl TryFrom<UtcTime> for SystemTime

Available on crate feature std only.

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: UtcTime) -> Result<Self, ConversionError>

Performs the conversion.

impl Copy for UtcTime

impl Eq for UtcTime

impl LifetimeFree for UtcTime

Available on crate feature castaway only.

impl StructuralPartialEq for UtcTime