Struct time::UtcOffset

pub struct UtcOffset { /* fields omitted */ }

An offset from UTC.

This struct can store values up to ±23:59:59. If you need support outside this range, please file an issue with your use case.

Implementations

impl UtcOffset

pub const UTC: Self

A UtcOffset that is UTC.

assert_eq!(UtcOffset::UTC, offset!("UTC"));

pub const fn from_hms(
    hours: i8,
    minutes: i8,
    seconds: i8
) -> Result<Self, ComponentRange>

Create a UtcOffset representing an offset by the number of hours, minutes, and seconds provided.

The sign of all three components should match. If they do not, all smaller components will have their signs flipped.

assert_eq!(UtcOffset::from_hms(1, 2, 3)?.as_hms(), (1, 2, 3));
assert_eq!(UtcOffset::from_hms(1, -2, -3)?.as_hms(), (1, 2, 3));

pub const fn as_hms(self) -> (i8, i8, i8)

Obtain the UTC offset as its hours, minutes, and seconds. The sign of all three components will always match. A positive value indicates an offset to the east; a negative to the west.

assert_eq!(offset!("+1:02:03").as_hms(), (1, 2, 3));
assert_eq!(offset!("-1:02:03").as_hms(), (-1, -2, -3));

pub const fn whole_hours(self) -> i8

Obtain the number of whole hours the offset is from UTC. A positive value indicates an offset to the east; a negative to the west.

assert_eq!(offset!("+1:02:03").whole_hours(), 1);
assert_eq!(offset!("-1:02:03").whole_hours(), -1);

pub const fn whole_minutes(self) -> i16

Obtain the number of whole minutes the offset is from UTC. A positive value indicates an offset to the east; a negative to the west.

assert_eq!(offset!("+1:02:03").whole_minutes(), 62);
assert_eq!(offset!("-1:02:03").whole_minutes(), -62);

pub const fn minutes_past_hour(self) -> i8

Obtain the number of minutes past the hour the offset is from UTC. A positive value indicates an offset to the east; a negative to the west.

assert_eq!(offset!("+1:02:03").minutes_past_hour(), 2);
assert_eq!(offset!("-1:02:03").minutes_past_hour(), -2);

pub const fn whole_seconds(self) -> i32

Obtain the number of whole seconds the offset is from UTC. A positive value indicates an offset to the east; a negative to the west.

assert_eq!(offset!("+1:02:03").whole_seconds(), 3723);
assert_eq!(offset!("-1:02:03").whole_seconds(), -3723);

pub const fn seconds_past_minute(self) -> i8

Obtain the number of seconds past the minute the offset is from UTC. A positive value indicates an offset to the east; a negative to the west.

assert_eq!(offset!("+1:02:03").seconds_past_minute(), 3);
assert_eq!(offset!("-1:02:03").seconds_past_minute(), -3);

pub const fn is_utc(self) -> bool

Check if the offset is exactly UTC.

assert!(!offset!("+1:02:03").is_utc());
assert!(!offset!("-1:02:03").is_utc());
assert!(offset!("UTC").is_utc());

pub const fn is_positive(self) -> bool

Check if the offset is positive, or east of UTC.

assert!(offset!("+1:02:03").is_positive());
assert!(!offset!("-1:02:03").is_positive());
assert!(!offset!("UTC").is_positive());

pub const fn is_negative(self) -> bool

Check if the offset is negative, or west of UTC.

assert!(!offset!("+1:02:03").is_negative());
assert!(offset!("-1:02:03").is_negative());
assert!(!offset!("UTC").is_negative());

pub fn local_offset_at(
    datetime: OffsetDateTime
) -> Result<Self, IndeterminateOffset>

This is supported on crate feature local-offset only.

Attempt to obtain the system’s UTC offset at a known moment in time. If the offset cannot be determined, an error is returned.

let local_offset = UtcOffset::local_offset_at(OffsetDateTime::UNIX_EPOCH);
assert!(local_offset.is_ok());

Due to a soundness bug, the error value is currently always returned on Unix-like platforms.

pub fn current_local_offset() -> Result<Self, IndeterminateOffset>

This is supported on crate feature local-offset only.

Attempt to obtain the system’s current UTC offset. If the offset cannot be determined, an error is returned.

let local_offset = UtcOffset::current_local_offset();
assert!(local_offset.is_ok());

impl UtcOffset

pub fn format_into(
    self,
    output: &mut impl Write,
    format: &impl Formattable
) -> Result<usize, Format>

This is supported on crate feature formatting only.

Format the UtcOffset using the provided format description. The formatted value will be output to the provided writer. The format description will typically be parsed by using format_description::parse.

pub fn format(self, format: &impl Formattable) -> Result<String, Format>

This is supported on crate feature formatting only.

Format the UtcOffset using the provided format description. The format description will typically be parsed by using format_description::parse.

let format = format_description::parse("[offset_hour sign:mandatory]:[offset_minute]")?;
assert_eq!(offset!("+1").format(&format)?, "+01:00");

impl UtcOffset

pub fn parse(input: &str, description: &impl Parsable) -> Result<Self, Parse>

This is supported on crate feature parsing only.

Parse a UtcOffset from the input using the provided format description. The format description will typically be parsed by using format_description::parse.

let format = format_description::parse("[offset_hour]:[offset_minute]")?;
assert_eq!(UtcOffset::parse("-03:42", &format)?, offset!("-3:42"));

Trait Implementations

impl Arbitrary for UtcOffset

This is supported on crate feature quickcheck only.

fn arbitrary(g: &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 Clone for UtcOffset

fn clone(&self) -> UtcOffset

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for UtcOffset

impl Debug for UtcOffset

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

Formats the value using the given formatter.

impl<'a> Deserialize<'a> for UtcOffset

This is supported on crate feature serde only.

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

Deserialize this value from the given Serde deserializer.

impl Display for UtcOffset

This is supported on crate feature formatting only.

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

Formats the value using the given formatter.

impl Eq for UtcOffset

impl Hash for UtcOffset

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Neg for UtcOffset

type Output = Self

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Ord for UtcOffset

fn cmp(&self, other: &UtcOffset) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<UtcOffset> for UtcOffset

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

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

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

This method tests for !=.

impl PartialOrd<UtcOffset> for UtcOffset

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

pub 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 Serialize for UtcOffset

This is supported on crate feature serde only.

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

Serialize this value into the given Serde serializer.

impl StructuralEq for UtcOffset

impl StructuralPartialEq for UtcOffset

impl TryFrom<Parsed> for UtcOffset

This is supported on crate feature parsing only.

type Error = TryFromParsed

The type returned in the event of a conversion error.

fn try_from(parsed: Parsed) -> Result<Self, Self::Error>

Performs the conversion.