Struct DateField 

pub struct DateField {
    pub raw: String,
    pub date: Option<Date>,
}

A frontmatter date field: the scalar exactly as written, plus its parse.

Keeping the raw text lets a consumer round-trip the value and lets the okf-validator crate report which scalar is malformed instead of silently dropping it: the spec’s permissiveness rule means an unparseable date must never make a document unreadable.

Fields

raw: String

The scalar as written in the frontmatter.

date: Option<Date>

The parsed date, or None if raw is not a YYYY-MM-DD date.

Implementations

impl DateField

pub fn new(raw: impl Into<String>) -> Self

Wraps a raw scalar, parsing it if possible.

pub const fn is_valid(&self) -> bool

true if the raw scalar parsed as a date.

pub fn effective_date(&self) -> Option<Date>

The date this field designates, accepting a datetime by taking its date part.

DateField::date is deliberately strict, because the spec asks stale_after for “an absolute date (YYYY-MM-DD)” and the validator should report a datetime there as the deviation it is. A comparison still has to reach a verdict, though, and reading a malformed date as “never stale” is the dangerous direction: a concept well past its date would look current. So comparisons use this instead, which matches the reference implementation’s is_stale (it truncates with date.fromisoformat(str(raw)[:10])). The written date is used as-is, without shifting by any UTC offset, exactly as that truncation does.

Trait Implementations

impl Clone for DateField

fn clone(&self) -> DateField

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DateField

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

Formats the value using the given formatter.

impl Display for DateField

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

Formats the value using the given formatter.

impl Eq for DateField

impl PartialEq for DateField

fn eq(&self, other: &DateField) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for DateField