Struct CycleRecord 

pub struct CycleRecord {
    pub name: String,
    pub description: Option<String>,
    pub start_date: Option<String>,
    pub due_date: Option<String>,
    pub schedule_id: Option<String>,
    pub sequence: Option<u32>,
    pub state: Option<String>,
}

One cycle as stored in docs/cycles/<name>.md frontmatter.

A generated cycle is a cycle

A cycle that a schedule generated carries its stable identity in the three optional fields below — the schedule it came from, its sequence within that schedule, and its own lifecycle state. They are optional and omitted when absent, so a hand-written cycle’s file is byte-identical to what it was before this existed, and deny_unknown_fields still holds: a generated cycle is the same record kind, not a second format.

That is what makes the compatiblity requirement work: an issue’s cycles value is a name, so a generated cycle must be resolvable by name through the normal cycle machinery (readers, the picker, tix cycle show). Its identity rides beside that name rather than replacing it, and the name stays mutable without touching the identity (C-002/C-003).

Fields

name: String

The cycle’s name (identity for a hand-written cycle; a mutable reference label for a generated one).

description: Option<String>

Optional human description.

start_date: Option<String>

Optional start date (YYYY-MM-DD).

due_date: Option<String>

Optional due date (YYYY-MM-DD).

schedule_id: Option<String>

The schedule that generated this cycle, by stable id. Absent on a hand-written cycle.

sequence: Option<u32>

The stable sequence of this cycle within its schedule. Absent on a hand-written cycle.

state: Option<String>

The generated cycle’s lifecycle state (active/closed/paused/skipped). Absent on a hand-written cycle.

Trait Implementations

impl Clone for CycleRecord

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 CycleRecord

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

Formats the value using the given formatter.

impl Default for CycleRecord

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CycleRecord

where CycleRecord: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for CycleRecord

impl From<CycleRecord> for PlanningCycle

fn from(record: CycleRecord) -> Self

Converts to this type from the input type.

impl HasName for CycleRecord

fn name(&self) -> &str

The record’s identity, as stored in its frontmatter name field.

impl PartialEq for CycleRecord

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for CycleRecord

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 CycleRecord