Struct icu_timezone::UtcOffset

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

An offset from Coordinated Universal Time (UTC)

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 from_eighths_of_hour(eighths_of_hour: i8) -> Self

Creates a UtcOffset from eighths of an hour.

This is chosen because eighths of an hour cover all current time zones and all values of i8 are within range of this type.

Examples

use icu::timezone::UtcOffset;

assert_eq!(
    UtcOffset::try_from_str("-0600").unwrap(),
    UtcOffset::from_eighths_of_hour(-6 * 8),
);

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::timezone::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 to_eighths_of_hour(self) -> i8

Returns the raw offset value in eights of an hour (7.5 minute units).

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

impl Eq for UtcOffset

impl StructuralPartialEq for UtcOffset