Struct Offset

pub struct Offset { /* private fields */ }

Represents the number of seconds offset from UTC.

Implementations

impl Offset

pub fn utc() -> Self

Generate a UTC based offset.

Examples

let offset = Offset::utc();
assert!(offset.is_utc());

let time = Time::new(2022, 7, 29, 12, 36, 0, 0, offset)?;
assert!(time.is_utc());

pub fn local() -> Self

Generate an offset based on the detected local time zone of the system.

Detection is done by tzdb::local_tz, and if it fails will return a GMT timezone.

The system timezone is detected on the first call to this function and will be constant for the life of the program.

Examples

let offset = Offset::local();
assert!(!offset.is_utc());

let time = Time::new(2022, 7, 29, 12, 36, 0, 0, offset)?;
assert!(!time.is_utc());

pub fn fixed(offset: i32) -> Result<Self, TimeError>

Generate an offset with a number of seconds from UTC.

Examples

let offset = Offset::fixed(6600)?; // +0150
assert!(!offset.is_utc());

let time = Time::new(2022, 7, 29, 12, 36, 0, 0, offset)?;
assert!(!time.is_utc());

The offset must be in range:

let offset = Offset::fixed(500_000); // +0150
assert!(offset.is_err());

Errors

Return a TimeError::TzOutOfRangeError when outside of range of acceptable offset of MIN_OFFSET_SECONDS to MAX_OFFSET_SECONDS.

pub fn is_utc(&self) -> bool

Returns whether this offset is UTC.

Examples

let offset = Offset::utc();
assert!(offset.is_utc());

let offset = Offset::fixed(6600)?; // +0150
assert!(!offset.is_utc());

Trait Implementations

impl Clone for Offset

fn clone(&self) -> Offset

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Offset

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

Formats the value using the given formatter.

impl From<TimeZoneRef<'static>> for Offset

fn from(tz: TimeZoneRef<'static>) -> Self

Converts to this type from the input type.

impl PartialEq for Offset

fn eq(&self, other: &Offset) -> 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 TryFrom<&[u8]> for Offset

type Error = TimeError

The type returned in the event of a conversion error.

fn try_from(input: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&str> for Offset

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

Construct a Offset based on the accepted MRI values.

Accepts:

• [+/-]HH[:]MM
• A-I representing +01:00 to +09:00.
• K-M representing +10:00 to +12:00.
• N-Y representing -01:00 to -12:00.
• Z representing UTC/Zulu time (0 offset).

type Error = TimeError

The type returned in the event of a conversion error.

impl TryFrom<String> for Offset

type Error = TimeError

The type returned in the event of a conversion error.

fn try_from(input: String) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<i32> for Offset

fn try_from(seconds: i32) -> Result<Self, Self::Error>

Construct a Offset with the offset in seconds from UTC.

See Offset::fixed.

type Error = TimeError

The type returned in the event of a conversion error.

impl Copy for Offset

impl Eq for Offset

impl StructuralPartialEq for Offset