Struct cursive::reexports::time::UtcOffset [−]
pub struct UtcOffset { /* fields omitted */ }
Expand description
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
impl UtcOffset
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 from_whole_seconds(
seconds: i32
) -> Result<UtcOffset, ComponentRange>
pub const fn from_whole_seconds(
seconds: i32
) -> Result<UtcOffset, 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));
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
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
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
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
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
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);
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
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
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<UtcOffset, IndeterminateOffset>
pub fn local_offset_at(
datetime: OffsetDateTime
) -> Result<UtcOffset, 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<UtcOffset, IndeterminateOffset>
pub fn current_local_offset() -> Result<UtcOffset, 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
impl UtcOffset
pub fn format_into(
self,
output: &mut impl Write,
format: &impl Formattable
) -> Result<usize, Format>
pub fn format_into(
self,
output: &mut impl Write,
format: &impl Formattable
) -> Result<usize, Format>
Format the UtcOffset
using the provided format description.
pub fn format(self, format: &impl Formattable) -> Result<String, Format>
pub fn format(self, format: &impl Formattable) -> Result<String, Format>
Format the UtcOffset
using the provided format description.
let format = format_description::parse("[offset_hour sign:mandatory]:[offset_minute]")?;
assert_eq!(offset!(+1).format(&format)?, "+01:00");
Trait Implementations
impl PartialOrd<UtcOffset> for UtcOffset
impl PartialOrd<UtcOffset> for UtcOffset
pub fn partial_cmp(&self, other: &UtcOffset) -> Option<Ordering>
pub fn partial_cmp(&self, other: &UtcOffset) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
This method tests less than (for self
and other
) and is used by the <
operator. Read more
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
impl StructuralEq for UtcOffset
impl StructuralPartialEq for UtcOffset
Auto Trait Implementations
impl RefUnwindSafe for UtcOffset
impl UnwindSafe for UtcOffset
Blanket Implementations
Mutably borrows from an owned value. Read more
Calls the given closure and return the result. Read more
Calls the given closure on self
.