Struct Parsed

pub struct Parsed {

    year: OptionRangedI32<{ MIN_YEAR }, { MAX_YEAR }>,
    year_century: OptionRangedI16<{ _ }, { _ }>,
    year_last_two: OptionRangedU8<0, 99>,
    iso_year: OptionRangedI32<{ MIN_YEAR }, { MAX_YEAR }>,
    iso_year_century: OptionRangedI16<{ _ }, { _ }>,
    iso_year_last_two: OptionRangedU8<0, 99>,
    month: Option<Month>,
    sunday_week_number: OptionRangedU8<0, 53>,
    monday_week_number: OptionRangedU8<0, 53>,
    iso_week_number: OptionRangedU8<1, 53>,
    weekday: Option<Weekday>,
    ordinal: OptionRangedU16<1, 366>,
    day: OptionRangedU8<1, 31>,
    hour_24: OptionRangedU8<0, { _ }>,
    hour_12: OptionRangedU8<1, 12>,
    hour_12_is_pm: Option<bool>,
    minute: OptionRangedU8<0, { _ }>,
    second: OptionRangedU8<0, { _ }>,
    subsecond: OptionRangedU32<0, { _ }>,
    offset_hour: OptionRangedI8<-23, 23>,
    offset_minute: OptionRangedI8<{ _ }, { _ }>,
    offset_second: OptionRangedI8<{ _ }, { _ }>,
    unix_timestamp_nanos: OptionRangedI128<{ _ }, { _ }>,
    offset_is_negative: bool,
    year_century_is_negative: bool,
    iso_year_century_is_negative: bool,
    pub(super) leap_second_allowed: bool,
}

All information parsed.

This information is directly used to construct the final values.

Most users will not need think about this struct in any way. It is public to allow for manual control over values, in the instance that the default parser is insufficient.

Fields

year: OptionRangedI32<{ MIN_YEAR }, { MAX_YEAR }>

Calendar year.

year_century: OptionRangedI16<{ _ }, { _ }>

All digits except the last two of the calendar year.

year_last_two: OptionRangedU8<0, 99>

The last two digits of the calendar year.

iso_year: OptionRangedI32<{ MIN_YEAR }, { MAX_YEAR }>

Year of the ISO week date.

iso_year_century: OptionRangedI16<{ _ }, { _ }>

All digits except the last two of the ISO week year.

iso_year_last_two: OptionRangedU8<0, 99>

The last two digits of the ISO week year.

month: Option<Month>

Month of the year.

sunday_week_number: OptionRangedU8<0, 53>

Week of the year, where week one begins on the first Sunday of the calendar year.

monday_week_number: OptionRangedU8<0, 53>

Week of the year, where week one begins on the first Monday of the calendar year.

iso_week_number: OptionRangedU8<1, 53>

Week of the year, where week one is the Monday-to-Sunday period containing January 4.

weekday: Option<Weekday>

Day of the week.

ordinal: OptionRangedU16<1, 366>

Day of the year.

day: OptionRangedU8<1, 31>

Day of the month.

hour_24: OptionRangedU8<0, { _ }>

Hour within the day.

hour_12: OptionRangedU8<1, 12>

Hour within the 12-hour period (midnight to noon or vice versa). This is typically used in conjunction with AM/PM, which is indicated by the hour_12_is_pm field.

hour_12_is_pm: Option<bool>

Whether the hour_12 field indicates a time that “PM”.

minute: OptionRangedU8<0, { _ }>

Minute within the hour.

second: OptionRangedU8<0, { _ }>

Second within the minute.

subsecond: OptionRangedU32<0, { _ }>

Nanosecond within the second.

offset_hour: OptionRangedI8<-23, 23>

Whole hours of the UTC offset.

offset_minute: OptionRangedI8<{ _ }, { _ }>

Minutes within the hour of the UTC offset.

offset_second: OptionRangedI8<{ _ }, { _ }>

Seconds within the minute of the UTC offset.

unix_timestamp_nanos: OptionRangedI128<{ _ }, { _ }>

The Unix timestamp in nanoseconds.

offset_is_negative: bool

Indicates whether the UtcOffset is negative. This information is obtained when parsing the offset hour, but may not otherwise be stored due to “-0” being equivalent to “0”.

year_century_is_negative: bool

Indicates whether the year_century component is negative. This information is obtained when parsing, but may not otherwise be stored due to “-0” being equivalent to “0”.

iso_year_century_is_negative: bool

Indicates whether the iso_year_century component is negative. This information is obtained when parsing, but may not otherwise be stored due to “-0” being equivalent to “0”.

leap_second_allowed: bool

Indicates whether a leap second is permitted to be parsed. This is required by some well-known formats.

Implementations

impl Parsed

pub const fn new() -> Self

Create a new instance of Parsed with no information known.

pub fn parse_item<'a>( &mut self, input: &'a [u8], item: &impl AnyFormatItem, ) -> Result<&'a [u8], ParseFromDescription>

Parse a single BorrowedFormatItem or OwnedFormatItem, mutating the struct. The remaining input is returned as the Ok value.

If a BorrowedFormatItem::Optional or OwnedFormatItem::Optional is passed, parsing will not fail; the input will be returned as-is if the expected format is not present.

pub fn parse_items<'a>( &mut self, input: &'a [u8], items: &[impl AnyFormatItem], ) -> Result<&'a [u8], ParseFromDescription>

Parse a sequence of BorrowedFormatItems or OwnedFormatItems, mutating the struct. The remaining input is returned as the Ok value.

This method will fail if any of the contained BorrowedFormatItems or OwnedFormatItems fail to parse. self will not be mutated in this instance.

pub fn parse_literal<'a>( input: &'a [u8], literal: &[u8], ) -> Result<&'a [u8], ParseFromDescription>

Parse a literal byte sequence. The remaining input is returned as the Ok value.

pub fn parse_component<'a>( &mut self, input: &'a [u8], component: Component, ) -> Result<&'a [u8], ParseFromDescription>

Parse a single component, mutating the struct. The remaining input is returned as the Ok value.

impl Parsed

Getter methods

pub const fn year(&self) -> Option<i32>

Obtain the year component.

pub const fn year_century(&self) -> Option<i16>

Obtain the year_century component.

If the year is zero, the sign of the century is not stored. To differentiate between positive and negative zero, use year_century_is_negative.

pub const fn year_century_is_negative(&self) -> Option<bool>

Obtain the year_century_is_negative component.

This indicates whether the value returned from year_century is negative. If the year is zero, it is necessary to call this method for disambiguation.

pub const fn year_last_two(&self) -> Option<u8>

Obtain the year_last_two component.

pub const fn iso_year(&self) -> Option<i32>

Obtain the iso_year component.

pub const fn iso_year_century(&self) -> Option<i16>

Obtain the iso_year_century component.

If the year is zero, the sign of the century is not stored. To differentiate between positive and negative zero, use iso_year_century_is_negative.

pub const fn iso_year_century_is_negative(&self) -> Option<bool>

Obtain the iso_year_century_is_negative component.

This indicates whether the value returned from iso_year_century is negative. If the year is zero, it is necessary to call this method for disambiguation.

pub const fn iso_year_last_two(&self) -> Option<u8>

Obtain the iso_year_last_two component.

pub const fn month(&self) -> Option<Month>

Obtain the month component.

pub const fn sunday_week_number(&self) -> Option<u8>

Obtain the sunday_week_number component.

pub const fn monday_week_number(&self) -> Option<u8>

Obtain the monday_week_number component.

pub const fn iso_week_number(&self) -> Option<NonZeroU8>

Obtain the iso_week_number component.

pub const fn weekday(&self) -> Option<Weekday>

Obtain the weekday component.

pub const fn ordinal(&self) -> Option<NonZeroU16>

Obtain the ordinal component.

pub const fn day(&self) -> Option<NonZeroU8>

Obtain the day component.

pub const fn hour_24(&self) -> Option<u8>

Obtain the hour_24 component.

pub const fn hour_12(&self) -> Option<NonZeroU8>

Obtain the hour_12 component.

pub const fn hour_12_is_pm(&self) -> Option<bool>

Obtain the hour_12_is_pm component.

pub const fn minute(&self) -> Option<u8>

Obtain the minute component.

pub const fn second(&self) -> Option<u8>

Obtain the second component.

pub const fn subsecond(&self) -> Option<u32>

Obtain the subsecond component.

pub const fn offset_hour(&self) -> Option<i8>

Obtain the offset_hour component.

#[doc(hidden)] pub const fn offset_minute(&self) -> Option<u8>

👎Deprecated since 0.3.8: use parsed.offset_minute_signed() instead

Obtain the absolute value of the offset_minute component.

pub const fn offset_minute_signed(&self) -> Option<i8>

Obtain the offset_minute component.

#[doc(hidden)] pub const fn offset_second(&self) -> Option<u8>

👎Deprecated since 0.3.8: use parsed.offset_second_signed() instead

Obtain the absolute value of the offset_second component.

pub const fn offset_second_signed(&self) -> Option<i8>

Obtain the offset_second component.

pub const fn unix_timestamp_nanos(&self) -> Option<i128>

Obtain the unix_timestamp_nanos component.

impl Parsed

Setter methods

All setters return Option<()>, which is Some if the value was set, and None if not. The setters may fail if the value is invalid, though behavior is not guaranteed.

pub fn set_year(&mut self, value: i32) -> Option<()>

Set the set_year component.

pub fn set_year_century(&mut self, value: i16, is_negative: bool) -> Option<()>

Set the year_century component.

If the value is zero, the sign of the century is taken from the second parameter. Otherwise the sign is inferred from the value.

pub fn set_year_last_two(&mut self, value: u8) -> Option<()>

Set the set_year_last_two component.

pub fn set_iso_year(&mut self, value: i32) -> Option<()>

Set the set_iso_year component.

pub fn set_iso_year_last_two(&mut self, value: u8) -> Option<()>

Set the set_iso_year_last_two component.

pub fn set_iso_year_century( &mut self, value: i16, is_negative: bool, ) -> Option<()>

Set the iso_year_century component.

If the value is zero, the sign of the century is taken from the second parameter. Otherwise the sign is inferred from the value.

pub fn set_month(&mut self, value: Month) -> Option<()>

Set the set_month component.

pub fn set_sunday_week_number(&mut self, value: u8) -> Option<()>

Set the set_sunday_week_number component.

pub fn set_monday_week_number(&mut self, value: u8) -> Option<()>

Set the set_monday_week_number component.

pub fn set_iso_week_number(&mut self, value: NonZeroU8) -> Option<()>

Set the set_iso_week_number component.

pub fn set_weekday(&mut self, value: Weekday) -> Option<()>

Set the set_weekday component.

pub fn set_ordinal(&mut self, value: NonZeroU16) -> Option<()>

Set the set_ordinal component.

pub fn set_day(&mut self, value: NonZeroU8) -> Option<()>

Set the set_day component.

pub fn set_hour_24(&mut self, value: u8) -> Option<()>

Set the set_hour_24 component.

pub fn set_hour_12(&mut self, value: NonZeroU8) -> Option<()>

Set the set_hour_12 component.

pub fn set_hour_12_is_pm(&mut self, value: bool) -> Option<()>

Set the set_hour_12_is_pm component.

pub fn set_minute(&mut self, value: u8) -> Option<()>

Set the set_minute component.

pub fn set_second(&mut self, value: u8) -> Option<()>

Set the set_second component.

pub fn set_subsecond(&mut self, value: u32) -> Option<()>

Set the set_subsecond component.

pub fn set_offset_hour(&mut self, value: i8) -> Option<()>

Set the set_offset_hour component.

pub fn set_offset_minute_signed(&mut self, value: i8) -> Option<()>

Set the set_offset_minute_signed component.

pub fn set_offset_second_signed(&mut self, value: i8) -> Option<()>

Set the set_offset_second_signed component.

pub fn set_unix_timestamp_nanos(&mut self, value: i128) -> Option<()>

Set the set_unix_timestamp_nanos component.

#[doc(hidden)] pub fn set_offset_minute(&mut self, value: u8) -> Option<()>

👎Deprecated since 0.3.8: use parsed.set_offset_minute_signed() instead

Set the offset_minute component.

#[doc(hidden)] pub fn set_offset_second(&mut self, value: u8) -> Option<()>

👎Deprecated since 0.3.8: use parsed.set_offset_second_signed() instead

Set the offset_minute component.

impl Parsed

Builder methods

All builder methods return Option<Self>, which is Some if the value was set, and None if not. The builder methods may fail if the value is invalid, though behavior is not guaranteed.

pub const fn with_year(self, value: i32) -> Option<Self>

Set the year component and return self.

pub const fn with_year_century( self, value: i16, is_negative: bool, ) -> Option<Self>

Set the year_century component and return self.

If the value is zero, the sign of the century is taken from the second parameter. Otherwise the sign is inferred from the value.

pub const fn with_year_last_two(self, value: u8) -> Option<Self>

Set the year_last_two component and return self.

pub const fn with_iso_year(self, value: i32) -> Option<Self>

Set the iso_year component and return self.

pub const fn with_iso_year_century( self, value: i16, is_negative: bool, ) -> Option<Self>

Set the iso_year_century component and return self.

If the value is zero, the sign of the century is taken from the second parameter. Otherwise the sign is inferred from the value.

pub const fn with_iso_year_last_two(self, value: u8) -> Option<Self>

Set the iso_year_last_two component and return self.

pub const fn with_month(self, value: Month) -> Option<Self>

Set the month component and return self.

pub const fn with_sunday_week_number(self, value: u8) -> Option<Self>

Set the sunday_week_number component and return self.

pub const fn with_monday_week_number(self, value: u8) -> Option<Self>

Set the monday_week_number component and return self.

pub const fn with_iso_week_number(self, value: NonZeroU8) -> Option<Self>

Set the iso_week_number component and return self.

pub const fn with_weekday(self, value: Weekday) -> Option<Self>

Set the weekday component and return self.

pub const fn with_ordinal(self, value: NonZeroU16) -> Option<Self>

Set the ordinal component and return self.

pub const fn with_day(self, value: NonZeroU8) -> Option<Self>

Set the day component and return self.

pub const fn with_hour_24(self, value: u8) -> Option<Self>

Set the hour_24 component and return self.

pub const fn with_hour_12(self, value: NonZeroU8) -> Option<Self>

Set the hour_12 component and return self.

pub const fn with_hour_12_is_pm(self, value: bool) -> Option<Self>

Set the hour_12_is_pm component and return self.

pub const fn with_minute(self, value: u8) -> Option<Self>

Set the minute component and return self.

pub const fn with_second(self, value: u8) -> Option<Self>

Set the second component and return self.

pub const fn with_subsecond(self, value: u32) -> Option<Self>

Set the subsecond component and return self.

pub const fn with_offset_hour(self, value: i8) -> Option<Self>

Set the offset_hour component and return self.

#[doc(hidden)] pub const fn with_offset_minute(self, value: u8) -> Option<Self>

👎Deprecated since 0.3.8: use parsed.with_offset_minute_signed() instead

Set the offset_minute component and return self.

pub const fn with_offset_minute_signed(self, value: i8) -> Option<Self>

Set the offset_minute component and return self.

#[doc(hidden)] pub const fn with_offset_second(self, value: u8) -> Option<Self>

👎Deprecated since 0.3.8: use parsed.with_offset_second_signed() instead

Set the offset_minute component and return self.

pub const fn with_offset_second_signed(self, value: i8) -> Option<Self>

Set the offset_second component and return self.

pub const fn with_unix_timestamp_nanos(self, value: i128) -> Option<Self>

Set the unix_timestamp_nanos component and return self.

Trait Implementations

impl Clone for Parsed

fn clone(&self) -> Parsed

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Parsed

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

Formats the value using the given formatter.

impl Default for Parsed

fn default() -> Self

Returns the “default value” for a type.

impl TryFrom<Parsed> for Date

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 TryFrom<Parsed> for OffsetDateTime

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 TryFrom<Parsed> for PrimitiveDateTime

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 TryFrom<Parsed> for Time

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 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 Parsed