Struct YmdHms 

pub struct YmdHms { /* private fields */ }

Combined date + time object.

Has calendar aware and, when the jiff-tz feature is enabled, timezone aware math functions.

Examples

Creating a YmdHms.

use deep_time::{Dt, Scale};

// clamped to 29
let x = Dt::from_ymd(2000, 2, 30, Scale::UTC, 0, 0, 0, 0).to_ymd();

assert_eq!(x.day(), 29);

Adding a year. 2000 is a leap year and Feb. 29th is possible, but 2001 isn’t a leap year so the day is clamped to the 28th.

use deep_time::{Dt, Scale};

let x = Dt::from_ymd(2000, 2, 29, Scale::UTC, 0, 0, 0, 0).to_ymd();
let x = x.add_yr(1);

assert_eq!(x.day(), 28);

Implementations

impl YmdHms

pub const fn new( yr: i64, mo: u8, day: u8, scale: Scale, hr: u8, min: u8, sec: u8, attos: u64, ) -> YmdHms

Create a new YmdHms, wrapper around Dt::from_ymd.

pub const fn to_dt(&self) -> Dt

Returns the Dt that was used to make this YmdHms object.

pub const fn add_yr(&self, n: i64) -> Self

Adds (or subtracts) whole years, preserving month and day-of-month.

• Uses standard last-day-of-month clamping.
• Negative values subtract.

pub const fn add_mo(&self, n: i64) -> Self

Adds (or subtracts) calendar months. Negative values subtract.

pub const fn add_wk(&self, n: i64) -> Self

Adds (or subtracts) calendar weeks. Negative values subtract.

pub const fn add_days(&self, n: i64) -> Self

Adds (or subtracts) calendar days. Negative values subtract.

pub const fn add_attos(&self, n: i128) -> Self

Adds (or subtracts) attoseconds. Negative values subtract.

pub const fn add_sec(&self, n: i64) -> Self

Adds (or subtracts) whole seconds. Negative values subtract.

pub const fn add_min(&self, n: i64) -> Self

Adds (or subtracts) whole minutes. Negative values subtract.

pub const fn add_hr(&self, n: i64) -> Self

Adds (or subtracts) whole hours. Negative values subtract.

pub const fn yr(&self) -> i64

Returns the year component.

pub const fn mo(&self) -> u8

Returns the month component (1–12).

pub const fn day(&self) -> u8

Returns the day-of-month component (1–31, depending on month/year).

pub const fn hr(&self) -> u8

Returns the hour component (0–23).

pub const fn min(&self) -> u8

Returns the minute component (0–59).

pub const fn sec(&self) -> u8

Returns the second component (0–60). The value 60 only occurs during a positive leap second on Scale::UTC / UtcSpice / UtcHist.

pub const fn attos(&self) -> u64

Returns the attosecond (sub-second) component (0 ≤ attos < 10¹⁸).

pub const fn time_scale(&self) -> Scale

The time scale that the object was created on.

pub const fn iso_yr(&self) -> i64

Returns the ISO week year (can differ from the calendar year near January 1 / December 31).

pub const fn iso_wk(&self) -> u8

Returns the ISO week number (1–53). Weeks start on Monday; week 1 is the week containing the first Thursday of the year.

pub const fn day_of_yr(&self) -> u16

Returns the day of the year (ordinal date), 1-based (Jan 1 = 1, Dec 31 = 365 or 366 in leap years).

pub const fn wkday(&self) -> u8

Returns the weekday number according to Dt::jd_to_wkday (typically 0 = Sunday … 6 = Saturday; exact convention is defined by the Julian Day helper).

pub const fn wk_of_yr_sun(&self) -> u8

Returns the week of year number when weeks are considered to start on Sunday (US-style numbering).

pub const fn wk_of_yr_mon(&self) -> u8

Returns the week of year number when weeks are considered to start on Monday.

impl YmdHms

pub fn add_yr_tz(&self, n: i64, tz: &str) -> Result<Self, DtErr>

Adds the given number of years in the specified IANA timezone, respecting timezone rules (including DST) and proper calendar arithmetic.

Errors

• DtErrKind::YearOutOfRange if the year of the date is outside the -9999..=9999 range (checked before involving Jiff).
• Specific errors for invalid time components when preparing values for Jiff: DtErrKind::InvalidHour, DtErrKind::InvalidMinute, DtErrKind::InvalidSecond, DtErrKind::InvalidMonth, or DtErrKind::InvalidDay.
• DtErrKind::InvalidTimeZone if Jiff cannot find/resolve the IANA timezone name.
• DtErrKind::OutOfRange if the result of the calendar arithmetic operation would be outside the range supported by Jiff (the checked_add fails).

pub fn add_mo_tz(&self, n: i64, tz: &str) -> Result<Self, DtErr>

Adds the given number of months in the specified IANA timezone, respecting timezone rules and calendar month-end clamping.

Errors

• DtErrKind::YearOutOfRange if the year of the date is outside the -9999..=9999 range (checked before involving Jiff).
• Specific errors for invalid time components when preparing values for Jiff: DtErrKind::InvalidHour, DtErrKind::InvalidMinute, DtErrKind::InvalidSecond, DtErrKind::InvalidMonth, or DtErrKind::InvalidDay.
• DtErrKind::InvalidTimeZone if Jiff cannot find/resolve the IANA timezone name.
• DtErrKind::OutOfRange if the result of the calendar arithmetic operation would be outside the range supported by Jiff (the checked_add fails).

pub fn add_wk_tz(&self, n: i64, tz: &str) -> Result<Self, DtErr>

Adds the given number of weeks in the specified IANA timezone.

Errors

• DtErrKind::YearOutOfRange if the year of the date is outside the -9999..=9999 range (checked before involving Jiff).
• Specific errors for invalid time components when preparing values for Jiff: DtErrKind::InvalidHour, DtErrKind::InvalidMinute, DtErrKind::InvalidSecond, DtErrKind::InvalidMonth, or DtErrKind::InvalidDay.
• DtErrKind::InvalidTimeZone if Jiff cannot find/resolve the IANA timezone name.
• DtErrKind::OutOfRange if the result of the calendar arithmetic operation would be outside the range supported by Jiff (the checked_add fails).

pub fn add_days_tz(&self, n: i64, tz: &str) -> Result<Self, DtErr>

Adds the given number of calendar days in the specified IANA timezone.

Errors

• DtErrKind::YearOutOfRange if the year of the date is outside the -9999..=9999 range (checked before involving Jiff).
• Specific errors for invalid time components when preparing values for Jiff: DtErrKind::InvalidHour, DtErrKind::InvalidMinute, DtErrKind::InvalidSecond, DtErrKind::InvalidMonth, or DtErrKind::InvalidDay.
• DtErrKind::InvalidTimeZone if Jiff cannot find/resolve the IANA timezone name.
• DtErrKind::OutOfRange if the result of the calendar arithmetic operation would be outside the range supported by Jiff (the checked_add fails).

pub fn add_hr_tz(&self, n: i64, tz: &str) -> Result<Self, DtErr>

Adds the given number of hours in the specified IANA timezone, respecting timezone rules (including DST).

Errors

• DtErrKind::YearOutOfRange if the year of the date is outside the -9999..=9999 range (checked before involving Jiff).
• Specific errors for invalid time components when preparing values for Jiff: DtErrKind::InvalidHour, DtErrKind::InvalidMinute, DtErrKind::InvalidSecond, DtErrKind::InvalidMonth, or DtErrKind::InvalidDay.
• DtErrKind::InvalidTimeZone if Jiff cannot find/resolve the IANA timezone name.
• DtErrKind::OutOfRange if the result of the calendar arithmetic operation would be outside the range supported by Jiff (the checked_add fails).

pub fn add_min_tz(&self, n: i64, tz: &str) -> Result<Self, DtErr>

Adds the given number of minutes in the specified IANA timezone, respecting timezone rules (including DST).

Errors

• DtErrKind::YearOutOfRange if the year of the date is outside the -9999..=9999 range (checked before involving Jiff).
• Specific errors for invalid time components when preparing values for Jiff: DtErrKind::InvalidHour, DtErrKind::InvalidMinute, DtErrKind::InvalidSecond, DtErrKind::InvalidMonth, or DtErrKind::InvalidDay.
• DtErrKind::InvalidTimeZone if Jiff cannot find/resolve the IANA timezone name.
• DtErrKind::OutOfRange if the result of the calendar arithmetic operation would be outside the range supported by Jiff (the checked_add fails).

pub fn add_sec_tz(&self, n: i64, tz: &str) -> Result<Self, DtErr>

Adds the given number of seconds in the specified IANA timezone.

Errors

• DtErrKind::YearOutOfRange if the year of the date is outside the -9999..=9999 range (checked before involving Jiff).
• Specific errors for invalid time components when preparing values for Jiff: DtErrKind::InvalidHour, DtErrKind::InvalidMinute, DtErrKind::InvalidSecond, DtErrKind::InvalidMonth, or DtErrKind::InvalidDay.
• DtErrKind::InvalidTimeZone if Jiff cannot find/resolve the IANA timezone name.
• DtErrKind::OutOfRange if the result of the calendar arithmetic operation would be outside the range supported by Jiff (the checked_add fails).

Trait Implementations

impl Clone for YmdHms

fn clone(&self) -> YmdHms

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for YmdHms

impl Debug for YmdHms

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for YmdHms

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for YmdHms

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

Formats the value using the given formatter.

impl Eq for YmdHms

impl Format for YmdHms

where Dt: Format,

fn format(&self, f: Formatter<'_>)

Writes the defmt representation of self to fmt.

impl Hash for YmdHms

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

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 PartialEq for YmdHms

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for YmdHms

impl Tsify for YmdHms

const DECL: &'static str = "/**\n * Combined date + time object.\n *\n * Has calendar aware and, when the `jiff-tz` feature is enabled,\n * timezone aware math functions.\n *\n * ## Examples\n *\n * **Creating a** [`YmdHms`].\n *\n * ```rust\n * use deep_time::{Dt, Scale};\n *\n * // clamped to 29\n * let x = Dt::from_ymd(2000, 2, 30, Scale::UTC, 0, 0, 0, 0).to_ymd();\n *\n * assert_eq!(x.day(), 29);\n * ```\n *\n * **Adding a year.** 2000 is a leap year and Feb. 29th is possible, but\n * 2001 isn\\\'t a leap year so the day is clamped to the 28th.\n *\n * ```rust\n * use deep_time::{Dt, Scale};\n *\n * let x = Dt::from_ymd(2000, 2, 29, Scale::UTC, 0, 0, 0, 0).to_ymd();\n * let x = x.add_yr(1);\n *\n * assert_eq!(x.day(), 28);\n * ```\n */\nexport interface YmdHms {\n yr: number;\n mo: number;\n day: number;\n hr: number;\n min: number;\n sec: number;\n attos: number;\n dt: Dt;\n}"

const SERIALIZATION_CONFIG: SerializationConfig

type JsType = JsType

fn into_js(&self) -> Result<Self::JsType, Error>

where Self: Serialize,

fn from_js<T>(js: T) -> Result<Self, Error>

where T: Into<JsValue>, Self: DeserializeOwned,