Struct UtcOffset

pub struct UtcOffset(/* private fields */);

An offset from Coordinated Universal Time (UTC).

Supports ±18:00:00.

The primary definition of this type is in the icu_time crate. Other ICU4X crates re-export it for convenience.

Implementations

impl UtcOffset

pub fn try_from_seconds(seconds: i32) -> Result<Self, InvalidOffsetError>

Attempt to create a UtcOffset from a seconds input.

Returns InvalidOffsetError if the seconds are out of bounds.

pub const fn zero() -> Self

Creates a UtcOffset of zero.

pub fn try_from_str(s: &str) -> Result<Self, InvalidOffsetError>

Parse a UtcOffset from bytes.

The offset must range from UTC-12 to UTC+14.

The string must be an ISO-8601 time zone designator: e.g. Z e.g. +05 e.g. +0500 e.g. +05:00

Examples

use icu::time::zone::UtcOffset;

let offset0: UtcOffset = UtcOffset::try_from_str("Z").unwrap();
let offset1: UtcOffset = UtcOffset::try_from_str("+05").unwrap();
let offset2: UtcOffset = UtcOffset::try_from_str("+0500").unwrap();
let offset3: UtcOffset = UtcOffset::try_from_str("-05:00").unwrap();

let offset_err0 =
    UtcOffset::try_from_str("0500").expect_err("Invalid input");
let offset_err1 =
    UtcOffset::try_from_str("+05000").expect_err("Invalid input");

assert_eq!(offset0.to_seconds(), 0);
assert_eq!(offset1.to_seconds(), 18000);
assert_eq!(offset2.to_seconds(), 18000);
assert_eq!(offset3.to_seconds(), -18000);

pub fn try_from_utf8(code_units: &[u8]) -> Result<Self, InvalidOffsetError>

See Self::try_from_str

pub fn from_seconds_unchecked(seconds: i32) -> Self

Create a UtcOffset from a seconds input without checking bounds.

pub fn to_seconds(self) -> i32

Returns the raw offset value in seconds.

pub fn is_non_negative(self) -> bool

Whether the UtcOffset is non-negative.

pub fn is_zero(self) -> bool

Whether the UtcOffset is zero.

pub fn hours_part(self) -> i32

Returns the hours part of if the UtcOffset

pub fn minutes_part(self) -> u32

Returns the minutes part of if the UtcOffset.

pub fn seconds_part(self) -> u32

Returns the seconds part of if the UtcOffset.

Trait Implementations

impl Clone for UtcOffset

fn clone(&self) -> UtcOffset

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UtcOffset

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

Formats the value using the given formatter.

impl Default for UtcOffset

fn default() -> UtcOffset

Returns the “default value” for a type.

impl FromStr for UtcOffset

type Err = InvalidOffsetError

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 IntoOption<UtcOffset> for UtcOffset

fn into_option(self) -> Option<Self>

Return self as an Option<T>

impl Ord for UtcOffset

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

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

fn partial_cmp(&self, other: &UtcOffset) -> 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 Copy for UtcOffset

impl Eq for UtcOffset

impl StructuralPartialEq for UtcOffset