Struct Iso8601

pub struct Iso8601<const CONFIG: EncodedConfig = { Config::DEFAULT.encode() }>;

Available on crate features formatting or parsing only.

The format described in ISO 8601.

This implementation is of ISO 8601-1:2019. It may not be compatible with other versions.

The const parameter CONFIG must be a value that was returned by Config::encode. Passing any other value is unspecified behavior.

Example: 1997-11-21T09:55:06.000000000-06:00

Examples

assert_eq!(
    datetime!(1997-11-12 9:55:06 -6:00).format(&Iso8601::DEFAULT)?,
    "1997-11-12T09:55:06.000000000-06:00"
);

Implementations

impl<const CONFIG: EncodedConfig> Iso8601<CONFIG>

const CONFIG: Config = _

Available on crate feature formatting only.

The user-provided configuration for the ISO 8601 format.

pub(crate) const FORMAT_DATE: bool = _

Available on crate feature formatting only.

Whether the date should be formatted.

pub(crate) const FORMAT_TIME: bool = _

Available on crate feature formatting only.

Whether the time should be formatted.

pub(crate) const FORMAT_OFFSET: bool = _

Available on crate feature formatting only.

Whether the UTC offset should be formatted.

pub(crate) const YEAR_IS_SIX_DIGITS: bool = _

Available on crate feature formatting only.

Whether the year is six digits.

pub(crate) const USE_SEPARATORS: bool = _

Available on crate feature formatting only.

Whether the format contains separators (such as - or :).

pub(crate) const DATE_KIND: DateKind = _

Available on crate feature formatting only.

Which format to use for the date.

pub(crate) const TIME_PRECISION: TimePrecision = _

Available on crate feature formatting only.

The precision and number of decimal digits to use for the time.

pub(crate) const OFFSET_PRECISION: OffsetPrecision = _

Available on crate feature formatting only.

The precision for the UTC offset.

impl Iso8601<DEFAULT>

pub const DEFAULT: Self = Self

An Iso8601 with the default configuration.

The following is the default behavior:

• The configuration can be used for both formatting and parsing.
• The date, time, and UTC offset are all formatted.
• Separators (such as - and :) are included.
• The year contains four digits, such that the year must be between 0 and 9999.
• The date uses the calendar format.
• The time has precision to the second and nine decimal digits.
• The UTC offset has precision to the minute.

If you need different behavior, use another associated constant. For full customization, use Config::DEFAULT and Config’s methods to create a custom configuration.

impl Iso8601<PARSING>

pub const PARSING: Self = Self

An Iso8601 that can only be used for parsing. Using this to format a value is unspecified behavior.

impl Iso8601<DATE>

pub const DATE: Self = Self

An Iso8601 that handles only the date, but is otherwise the same as Config::DEFAULT.

impl Iso8601<TIME>

pub const TIME: Self = Self

An Iso8601 that handles only the time, but is otherwise the same as Config::DEFAULT.

impl Iso8601<OFFSET>

pub const OFFSET: Self = Self

An Iso8601 that handles only the UTC offset, but is otherwise the same as Config::DEFAULT.

impl Iso8601<DATE_TIME>

pub const DATE_TIME: Self = Self

An Iso8601 that handles the date and time, but is otherwise the same as Config::DEFAULT.

impl Iso8601<DATE_TIME_OFFSET>

pub const DATE_TIME_OFFSET: Self = Self

An Iso8601 that handles the date, time, and UTC offset. This is the same as Config::DEFAULT.

impl Iso8601<TIME_OFFSET>

pub const TIME_OFFSET: Self = Self

An Iso8601 that handles the time and UTC offset, but is otherwise the same as Config::DEFAULT.

impl<const CONFIG: EncodedConfig> Iso8601<CONFIG>

pub(crate) fn parse_date<'a>( parsed: &'a mut Parsed, extended_kind: &'a mut ExtendedKind, ) -> impl FnMut(&[u8]) -> Result<&[u8], Parse> + 'a

Available on crate feature parsing only.

Parse a date in the basic or extended format. Reduced precision is permitted.

pub(crate) fn parse_time<'a>( parsed: &'a mut Parsed, extended_kind: &'a mut ExtendedKind, date_is_present: bool, ) -> impl FnMut(&[u8]) -> Result<&[u8], Parse> + 'a

Available on crate feature parsing only.

Parse a time in the basic or extended format. Reduced precision is permitted.

pub(crate) fn parse_offset<'a>( parsed: &'a mut Parsed, extended_kind: &'a mut ExtendedKind, ) -> impl FnMut(&[u8]) -> Result<&[u8], Parse> + 'a

Available on crate feature parsing only.

Parse a UTC offset in the basic or extended format. Reduced precision is supported.

Trait Implementations

impl<const CONFIG: EncodedConfig> Clone for Iso8601<CONFIG>

fn clone(&self) -> Iso8601<CONFIG>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const CONFIG: EncodedConfig> Debug for Iso8601<CONFIG>

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

Formats the value using the given formatter.

impl<const CONFIG: EncodedConfig> Eq for Iso8601<CONFIG>

#[doc(hidden)] fn assert_receiver_is_total_eq(&self)

impl<const CONFIG: EncodedConfig> PartialEq for Iso8601<CONFIG>

fn eq(&self, other: &Iso8601<CONFIG>) -> 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<const CONFIG: EncodedConfig> Sealed for Iso8601<CONFIG>

Available on crate feature formatting only.

fn format_into( &self, output: &mut impl Write, date: Option<Date>, time: Option<Time>, offset: Option<UtcOffset>, ) -> Result<usize, Format>

Format the item into the provided output, returning the number of bytes written.

fn format( &self, date: Option<Date>, time: Option<Time>, offset: Option<UtcOffset>, ) -> Result<String, Format>

Format the item directly to a String.

impl<const CONFIG: EncodedConfig> Sealed for Iso8601<CONFIG>

Available on crate feature parsing only.

fn parse_into<'a>( &self, input: &'a [u8], parsed: &mut Parsed, ) -> Result<&'a [u8], Parse>

Parse the item into the provided Parsed struct.

fn parse(&self, input: &[u8]) -> Result<Parsed, Parse>

Parse the item into a new Parsed struct.

fn parse_date(&self, input: &[u8]) -> Result<Date, Parse>

Parse a Date from the format description.

fn parse_time(&self, input: &[u8]) -> Result<Time, Parse>

Parse a Time from the format description.

fn parse_offset(&self, input: &[u8]) -> Result<UtcOffset, Parse>

Parse a UtcOffset from the format description.

fn parse_primitive_date_time( &self, input: &[u8], ) -> Result<PrimitiveDateTime, Parse>

Parse a PrimitiveDateTime from the format description.

fn parse_utc_date_time(&self, input: &[u8]) -> Result<UtcDateTime, Parse>

Parse a UtcDateTime from the format description.

fn parse_offset_date_time(&self, input: &[u8]) -> Result<OffsetDateTime, Parse>

Parse a OffsetDateTime from the format description.

impl<const CONFIG: EncodedConfig> Copy for Iso8601<CONFIG>

impl<const CONFIG: EncodedConfig> Formattable for Iso8601<CONFIG>

Available on crate feature formatting only.

impl<const CONFIG: EncodedConfig> Parsable for Iso8601<CONFIG>

Available on crate feature parsing only.

impl<const CONFIG: EncodedConfig> StructuralPartialEq for Iso8601<CONFIG>