Struct SeriesRef 

pub struct SeriesRef {
    pub id: String,
    pub name: Option<String>,
    pub date: Option<String>,
    pub key: Option<String>,
    pub rule: Option<SeriesRule>,
    pub state: Option<SeriesLifecycle>,
    pub next_cursor: Option<String>,
    pub skipped: Vec<String>,
}

One table, two roles, told apart by which fields are set — the definition carries rule, an occurrence carries key/date. A role: flag would be a second source of truth a writer could disagree with, so there is none: [crate::recurrence::series::SeriesRef::role] derives it.

Identity is (id, date) and never the issue number, the title, or the filename (C-002): those are display values that move, and an occurrence that moved with them would be generated twice.

Fields

id: String

The stable series id. Required in both roles.

name: Option<String>

The series’ display name. Mutable label, never identity; on the definition, and copied onto an occurrence for readability.

date: Option<String>

The canonical local date key (YYYY-MM-DD) an occurrence was generated for. Set on occurrences only.

key: Option<String>

The occurrence’s idempotency key (<series-id>@<YYYY-MM-DD>). Stored rather than re-derived, so a file whose key the current rule would no longer produce is still readable — and still a no-op (C-006).

rule: Option<SeriesRule>

The schedule, as the file spells it. Set on the definition only.

state: Option<SeriesLifecycle>

The lifecycle state. Set on the definition only.

next_cursor: Option<String>

The generation cursor: the last date the generator considered. Set on the definition only.

skipped: Vec<String>

Occurrence dates the user explicitly skipped, so generation never recreates them (C-006). Set on the definition only.

Implementations

impl SeriesRef

pub fn role(&self) -> SeriesRole

The role this table plays, decided by its fields (see the module docs).

A table with a rule is a definition; anything else is an occurrence — a table with neither is an occurrence missing its key, which SeriesIndex::build reports rather than guessing at.

Trait Implementations

impl Clone for SeriesRef

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SeriesRef

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

Formats the value using the given formatter.

impl Default for SeriesRef

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SeriesRef

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for SeriesRef

impl PartialEq for SeriesRef

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for SeriesRef

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 SeriesRef