Struct DateValue 

pub struct DateValue {
    pub value: String,
    pub note: Option<String>,
}

An EDTF date value, with an optional opaque note.

value is the canonical EDTF string driving all date computation (sorting, disambiguation, fallback selection). note is optional, uninterpreted display text a data producer supplies alongside the date — e.g. source-calendar wording such as 民国三十六年 next to a Gregorian value of "1947". Citum never parses, converts, or validates note; see docs/specs/CALENDAR_DATE_ANNOTATIONS.md.

The wire format is backward compatible: a bare EDTF string ("1947") deserializes with note: None and serializes back to the same bare string. Supplying a note requires the mapping form { value: "1947", note: "..." }, and only then does serialization emit the mapping form.

Fields

value: String

The EDTF value.

note: Option<String>

Optional opaque, uninterpreted text alongside the date. Preserved verbatim; never parsed, converted, or validated.

Implementations

impl DateValue

pub fn new(value: impl Into<String>) -> DateValue

Construct a DateValue with no note, from any string-like value.

pub fn is_empty(&self) -> bool

Check if the date value is empty.

pub fn parse(&self) -> RefDate

Parse the string as an EDTF date etc, or return the string as a literal.

pub fn year(&self) -> String

Extract the year from the date.

pub fn day(&self) -> Option<u32>

Extract the day from the date.

pub fn is_uncertain(&self) -> bool

Check if the date is uncertain (has “?” qualifier).

pub fn is_approximate(&self) -> bool

Check if the date is approximate (has “~” qualifier).

pub fn is_range(&self) -> bool

Check if the date is a range (interval).

pub fn is_open_range(&self) -> bool

Check if the range is open-ended (ends with “..”).

pub fn time(&self) -> Option<Time>

Extract the time component from the date, if present.

pub fn has_time(&self) -> bool

Check if the date has a time component.

Trait Implementations

impl Clone for DateValue

fn clone(&self) -> DateValue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DateValue

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

Formats the value using the given formatter.

impl Default for DateValue

fn default() -> DateValue

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DateValue

fn deserialize<D>( deserializer: D, ) -> Result<DateValue, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for DateValue

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

Formats the value using the given formatter.

impl From<&str> for DateValue

fn from(value: &str) -> DateValue

Converts to this type from the input type.

impl From<DateVariable> for DateValue

fn from(date: DateVariable) -> DateValue

Converts to this type from the input type.

impl From<String> for DateValue

fn from(value: String) -> DateValue

Converts to this type from the input type.

impl PartialEq for DateValue

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for DateValue

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for DateValue