Enum Dst

pub enum Dst {
    No,
    Yes,
}

Available on crate features dep_jiff and alloc only.

An enum indicating whether a particular datetime is in DST or not.

DST stands for “daylight saving time.” It is a label used to apply to points in time as a way to contrast it with “standard time.” DST is usually, but not always, one hour ahead of standard time. When DST takes effect is usually determined by governments, and the rules can vary depending on the location. DST is typically used as a means to maximize “sunlight” time during typical working hours, and as a cost cutting measure by reducing energy consumption. (The effectiveness of DST and whether it is overall worth it is a separate question entirely.)

In general, most users should never need to deal with this type. But it can be occasionally useful in circumstances where callers need to know whether DST is active or not for a particular point in time.

This type has a From<bool> trait implementation, where the bool is interpreted as being true when DST is active.

Variants

No

DST is not in effect. In other words, standard time is in effect.

Yes

DST is in effect.

Implementations

impl Dst

pub fn is_dst(self) -> bool

Returns true when this value is equal to Dst::Yes.

pub fn is_std(self) -> bool

Returns true when this value is equal to Dst::No.

std in this context refers to “standard time.” That is, it is the offset from UTC used when DST is not in effect.

Trait Implementations

impl Clone for Dst

fn clone(&self) -> Dst

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Dst

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

Formats the value using the given formatter.

impl From<bool> for Dst

fn from(is_dst: bool) -> Dst

Converts to this type from the input type.

impl Hash for Dst

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 Ord for Dst

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

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

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

impl Eq for Dst

impl StructuralPartialEq for Dst