Struct Utc

pub struct Utc;

The UTC time zone. This is the most efficient time zone when you don’t need the local time. It is also used as an offset (which is also a dummy type).

Using the TimeZone methods on the UTC struct is the preferred way to construct DateTime<Utc> instances.

Example

use chrono::{DateTime, TimeZone, Utc};

let dt = DateTime::from_timestamp(61, 0).unwrap();

assert_eq!(Utc.timestamp_opt(61, 0).unwrap(), dt);
assert_eq!(Utc.with_ymd_and_hms(1970, 1, 1, 0, 1, 1).unwrap(), dt);

Implementations

impl Utc

pub fn today() -> Date<Utc>

👎Deprecated since 0.4.23: use Utc::now() instead, potentially with .date_naive()

Available on crate feature now only.

Returns a Date which corresponds to the current date.

pub fn now() -> DateTime<Utc>

Available on crate feature now and not (WebAssembly and crate feature wasmbind and neither Emscripten nor WASI) only.

Returns a DateTime<Utc> which corresponds to the current date and time in UTC.

See also the similar Local::now() which returns DateTime<Local>, i.e. the local date and time including offset from UTC.

Example

// Current time in UTC
let now_utc = Utc::now();

// Current date in UTC
let today_utc = now_utc.date_naive();

// Current time in some timezone (let's use +05:00)
let offset = FixedOffset::east_opt(5 * 60 * 60).unwrap();
let now_with_offset = Utc::now().with_timezone(&offset);

Trait Implementations

impl Clone for Utc

fn clone(&self) -> Utc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Utc

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

Formats the value using the given formatter.

impl Display for Utc

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

Formats the value using the given formatter.

impl Hash for Utc

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 Offset for Utc

fn fix(&self) -> FixedOffset

Returns the fixed offset from UTC to the local time stored.

impl PartialEq for Utc

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

type Offset = Utc

An associated offset type. This type is used to store the actual offset in date and time types. The original TimeZone value can be recovered via TimeZone::from_offset.

fn from_offset(_state: &Utc) -> Utc

Reconstructs the time zone from the offset.

fn offset_from_local_date(&self, _local: &NaiveDate) -> MappedLocalTime<Utc>

Creates the offset(s) for given local NaiveDate if possible.

fn offset_from_local_datetime( &self, _local: &NaiveDateTime, ) -> MappedLocalTime<Utc>

Creates the offset(s) for given local NaiveDateTime if possible.

fn offset_from_utc_date(&self, _utc: &NaiveDate) -> Utc

Creates the offset for given UTC NaiveDate. This cannot fail.

fn offset_from_utc_datetime(&self, _utc: &NaiveDateTime) -> Utc

Creates the offset for given UTC NaiveDateTime. This cannot fail.

fn with_ymd_and_hms( &self, year: i32, month: u32, day: u32, hour: u32, min: u32, sec: u32, ) -> MappedLocalTime<DateTime<Self>>

Make a new DateTime from year, month, day, time components and current time zone.

fn ymd(&self, year: i32, month: u32, day: u32) -> Date<Self>

👎Deprecated since 0.4.23: use with_ymd_and_hms() instead

Makes a new Date from year, month, day and the current time zone. This assumes the proleptic Gregorian calendar, with the year 0 being 1 BCE.

fn ymd_opt( &self, year: i32, month: u32, day: u32, ) -> MappedLocalTime<Date<Self>>

👎Deprecated since 0.4.23: use with_ymd_and_hms() instead

Makes a new Date from year, month, day and the current time zone. This assumes the proleptic Gregorian calendar, with the year 0 being 1 BCE.

fn yo(&self, year: i32, ordinal: u32) -> Date<Self>

👎Deprecated since 0.4.23: use from_local_datetime() with a NaiveDateTime instead

Makes a new Date from year, day of year (DOY or “ordinal”) and the current time zone. This assumes the proleptic Gregorian calendar, with the year 0 being 1 BCE.

fn yo_opt(&self, year: i32, ordinal: u32) -> MappedLocalTime<Date<Self>>

👎Deprecated since 0.4.23: use from_local_datetime() with a NaiveDateTime instead

Makes a new Date from year, day of year (DOY or “ordinal”) and the current time zone. This assumes the proleptic Gregorian calendar, with the year 0 being 1 BCE.

fn isoywd(&self, year: i32, week: u32, weekday: Weekday) -> Date<Self>

👎Deprecated since 0.4.23: use from_local_datetime() with a NaiveDateTime instead

Makes a new Date from ISO week date (year and week number), day of the week (DOW) and the current time zone. This assumes the proleptic Gregorian calendar, with the year 0 being 1 BCE. The resulting Date may have a different year from the input year.

fn isoywd_opt( &self, year: i32, week: u32, weekday: Weekday, ) -> MappedLocalTime<Date<Self>>

👎Deprecated since 0.4.23: use from_local_datetime() with a NaiveDateTime instead

Makes a new Date from ISO week date (year and week number), day of the week (DOW) and the current time zone. This assumes the proleptic Gregorian calendar, with the year 0 being 1 BCE. The resulting Date may have a different year from the input year.

fn timestamp(&self, secs: i64, nsecs: u32) -> DateTime<Self>

👎Deprecated since 0.4.23: use timestamp_opt() instead

Makes a new DateTime from the number of non-leap seconds since January 1, 1970 0:00:00 UTC (aka “UNIX timestamp”) and the number of nanoseconds since the last whole non-leap second.

fn timestamp_opt( &self, secs: i64, nsecs: u32, ) -> MappedLocalTime<DateTime<Self>>

Makes a new DateTime from the number of non-leap seconds since January 1, 1970 0:00:00 UTC (aka “UNIX timestamp”) and the number of nanoseconds since the last whole non-leap second.

fn timestamp_millis(&self, millis: i64) -> DateTime<Self>

👎Deprecated since 0.4.23: use timestamp_millis_opt() instead

Makes a new DateTime from the number of non-leap milliseconds since January 1, 1970 0:00:00 UTC (aka “UNIX timestamp”).

fn timestamp_millis_opt(&self, millis: i64) -> MappedLocalTime<DateTime<Self>>

Makes a new DateTime from the number of non-leap milliseconds since January 1, 1970 0:00:00 UTC (aka “UNIX timestamp”).

fn timestamp_nanos(&self, nanos: i64) -> DateTime<Self>

Makes a new DateTime from the number of non-leap nanoseconds since January 1, 1970 0:00:00 UTC (aka “UNIX timestamp”).

fn timestamp_micros(&self, micros: i64) -> MappedLocalTime<DateTime<Self>>

Makes a new DateTime from the number of non-leap microseconds since January 1, 1970 0:00:00 UTC (aka “UNIX timestamp”).

fn datetime_from_str(&self, s: &str, fmt: &str) -> ParseResult<DateTime<Self>>

👎Deprecated since 0.4.29: use DateTime::parse_from_str or NaiveDateTime::parse_from_str with and_utc() or and_local_timezone() instead

Parses a string with the specified format string and returns a DateTime with the current offset.

fn from_local_date(&self, local: &NaiveDate) -> MappedLocalTime<Date<Self>>

👎Deprecated since 0.4.23: use from_local_datetime() instead

Converts the local NaiveDate to the timezone-aware Date if possible.

fn from_local_datetime( &self, local: &NaiveDateTime, ) -> MappedLocalTime<DateTime<Self>>

Converts the local NaiveDateTime to the timezone-aware DateTime if possible.

fn from_utc_date(&self, utc: &NaiveDate) -> Date<Self>

👎Deprecated since 0.4.23: use from_utc_datetime() instead

Converts the UTC NaiveDate to the local time. The UTC is continuous and thus this cannot fail (but can give the duplicate local time).

fn from_utc_datetime(&self, utc: &NaiveDateTime) -> DateTime<Self>

Converts the UTC NaiveDateTime to the local time. The UTC is continuous and thus this cannot fail (but can give the duplicate local time).

impl Copy for Utc

impl Eq for Utc

impl StructuralPartialEq for Utc