Struct UtcOffset 

#[repr(C)]
pub struct UtcOffset {
    seconds: ri8<{ _ }, { _ }>,
    minutes: ri8<{ _ }, { _ }>,
    hours: ri8<-25, 25>,
}

An offset from UTC.

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

Fields

seconds: ri8<{ _ }, { _ }>

minutes: ri8<{ _ }, { _ }>

hours: ri8<-25, 25>

Implementations

impl UtcOffset

pub const UTC: Self

A UtcOffset that is UTC.

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

pub(crate) const fn as_u32_for_equality(self) -> u32

Provide a representation of the UtcOffset as a i32. This value can be used for equality, and hashing. This value is not suitable for ordering; use as_i32_for_comparison instead.

const fn as_i32_for_comparison(self) -> i32

Provide a representation of the UtcOffset as a i32. This value can be used for ordering. While it is suitable for equality, as_u32_for_equality is preferred for performance reasons.

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(crate) const fn from_hms_ranged_unchecked( hours: ri8<-25, 25>, minutes: ri8<{ _ }, { _ }>, seconds: ri8<{ _ }, { _ }>, ) -> Self

Create a UtcOffset representing an offset of the hours, minutes, and seconds provided. All three parameters must have the same sign.

While the signs of the parameters are required to match, this is not a safety invariant.

pub(crate) const fn from_hms_ranged( hours: ri8<-25, 25>, minutes: ri8<{ _ }, { _ }>, seconds: ri8<{ _ }, { _ }>, ) -> Self

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.

pub const fn from_whole_seconds(seconds: i32) -> Result<Self, ComponentRange>

Create a UtcOffset representing an offset by the number of seconds provided.

assert_eq!(UtcOffset::from_whole_seconds(3_723)?.as_hms(), (1, 2, 3));

pub(crate) const fn from_whole_seconds_ranged( seconds: ri32<{ _ }, { _ }>, ) -> Self

Create a UtcOffset representing an offset by the number of seconds provided.

assert_eq!(
    UtcOffset::from_whole_seconds_ranged(RangedI32::new_static::<3_723>()).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(crate) const fn as_hms_ranged( self, ) -> (ri8<-25, 25>, ri8<{ _ }, { _ }>, ri8<{ _ }, { _ }>)

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.

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>

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());

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

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 + ?Sized), format: &(impl Formattable + ?Sized), ) -> Result<usize, Format>

Format the UtcOffset using the provided format description.

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

Format the UtcOffset using the provided format description.

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

impl UtcOffset

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

Parse a UtcOffset from the input using the provided format description.

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

impl UtcOffset

pub(crate) const DISPLAY_BUFFER_SIZE: usize = 9

The maximum number of bytes that the fmt_into_buffer method will write, which is also used for the Display implementation.

pub(crate) const fn fmt_into_buffer( self, buf: &mut [MaybeUninit<u8>; 9], ) -> usize

Format the UtcOffset into the provided buffer, returning the number of bytes written.

Trait Implementations

impl Clone for UtcOffset

fn clone(&self) -> UtcOffset

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComponentProvider for UtcOffset

const SUPPLIES_OFFSET: bool = true

Whether the type can provide offset components, indicating that offset-related methods can be called.

type State = ()

The state type used by the provider, allowing for caching of computed values.

fn offset_is_negative(&self, _: &mut Self::State) -> bool

Obtain whether the offset is negative.

fn offset_is_utc(&self, _state: &mut Self::State) -> bool

Obtain whether the offset is UTC.

fn offset_hour(&self, _: &mut Self::State) -> ri8<-25, 25>

Obtain the hour component of the UTC offset.

fn offset_minute(&self, _: &mut Self::State) -> ri8<{ _ }, { _ }>

Obtain the minute component of the UTC offset.

fn offset_second(&self, _: &mut Self::State) -> ri8<{ _ }, { _ }>

Obtain the second component of the UTC offset.

const SUPPLIES_DATE: bool = false

Whether the type can provide date components, indicating that date-related methods can be called.

const SUPPLIES_TIME: bool = false

Whether the type can provide time components, indicating that time-related methods can be called.

const SUPPLIES_TIMESTAMP: bool = false

Whether the type can provide timestamp components, indicating that timestamp-related methods can be called.

fn day(&self, state: &mut Self::State) -> ru8<1, 31>

Obtain the day of the month.

fn month(&self, state: &mut Self::State) -> Month

Obtain the month of the year.

fn ordinal(&self, state: &mut Self::State) -> ru16<1, 366>

Obtain the ordinal day of the year.

fn weekday(&self, state: &mut Self::State) -> Weekday

Obtain the day of the week.

fn iso_week_number(&self, state: &mut Self::State) -> ru8<1, 53>

Obtain the ISO week number.

fn monday_based_week(&self, state: &mut Self::State) -> ru8<0, 53>

Obtain the Monday-based week number.

fn sunday_based_week(&self, state: &mut Self::State) -> ru8<0, 53>

Obtain the Sunday-based week number.

fn calendar_year(&self, state: &mut Self::State) -> ri32<-999_999, 999_999>

Obtain the calendar year.

fn iso_year(&self, state: &mut Self::State) -> ri32<-999_999, 999_999>

Obtain the ISO week-based year.

fn hour(&self, state: &mut Self::State) -> ru8<0, { _ }>

Obtain the hour within the day.

fn minute(&self, state: &mut Self::State) -> ru8<0, { _ }>

Obtain the minute within the hour.

fn period(&self, state: &mut Self::State) -> Period

Obtain the period of the day (AM/PM).

fn second(&self, state: &mut Self::State) -> ru8<0, { _ }>

Obtain the second within the minute.

fn nanosecond(&self, state: &mut Self::State) -> ru32<0, { _ }>

Obtain the nanosecond within the second.

fn unix_timestamp_seconds(&self, state: &mut Self::State) -> i64

Obtain the Unix timestamp in seconds.

fn unix_timestamp_milliseconds(&self, state: &mut Self::State) -> i64

Obtain the Unix timestamp in milliseconds.

fn unix_timestamp_microseconds(&self, state: &mut Self::State) -> i128

Obtain the Unix timestamp in microseconds.

fn unix_timestamp_nanoseconds(&self, state: &mut Self::State) -> i128

Obtain the Unix timestamp in nanoseconds.

impl Debug for UtcOffset

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

Formats the value using the given formatter.

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

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

where D: Deserializer<'a>,

Deserialize this value from the given Serde deserializer.

impl Display for UtcOffset

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

Formats the value using the given formatter.

impl Hash for UtcOffset

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

where H: Hasher,

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

type Output = UtcOffset

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Ord for UtcOffset

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

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl SmartDisplay for UtcOffset

type Metadata = UtcOffsetMetadata

User-provided metadata type.

fn metadata(&self, _: FormatterOptions) -> Metadata<'_, Self>

Compute any information needed to format the value. This must, at a minimum, determine the width of the value before any padding is added by the formatter.

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

Format the value using the given formatter. This is the same as Display::fmt.

fn fmt_with_metadata( &self, f: &mut Formatter<'_>, _metadata: Metadata<'_, Self>, ) -> Result<(), Error>

Format the value using the given formatter and metadata. The formatted output should have the width indicated by the metadata. This is before any padding is added by the formatter.

impl TryFrom<Parsed> for UtcOffset

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.

impl Copy for UtcOffset

impl Eq for UtcOffset