Struct CycleStore 

pub struct CycleStore { /* private fields */ }

A cycle store rooted at a project root (root/docs/cycles).

Implementations

impl CycleStore

pub fn new(root: &Path) -> Self

Bind the store to root/docs/cycles; the directory is not created here.

pub fn dir(&self) -> &Path

The directory backing this store.

pub fn exists(&self) -> bool

Whether docs/cycles/ exists. Its absence means “read legacy tix.toml” and is not an error.

pub fn list(&self) -> Result<Vec<CycleRecord>>

Every stored cycle, sorted by filename, with the implicit Default cycle always available. A missing directory yields just Default.

pub fn get(&self, name: &str) -> Result<CycleRecord>

Look a cycle up by name. The implicit Default cycle is only returned when it is a real file; callers that need the synthetic default use CycleStore::list.

pub fn save( &self, name: &str, cycle: &PlanningCycle, body: Option<&str>, ) -> Result<()>

Write a cycle to docs/cycles/<slug(name)>.md, replacing any file of that name and creating the directory on demand.

Identity survives the legacy path. This is the write a hand-written cycle edit goes through, and it takes only a PlanningCycle, which has no notion of a generated identity — so the record already on disk is read first and its schedule_id/sequence/state are carried over. Without that, one tix cycle edit on a generated cycle would silently strip the stable identity its snapshots and idempotency keys hang off.

A generated cycle is written through CycleStore::save_record, which takes the whole record.

pub fn save_record( &self, record: &CycleRecord, body: Option<&str>, ) -> Result<()>

Write a whole CycleRecord — the path a generated cycle takes, because it is the only one that can carry the identity fields.

pub fn rename(&self, old: &str, new: &str) -> Result<()>

Rename a stored cycle, moving its file and rebasing the frontmatter name. The body is preserved. A name that is not stored is a TixError::NotFound.

pub fn delete(&self, name: &str) -> Result<()>

Delete a stored cycle by name.

Trait Implementations

impl Clone for CycleStore

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 CycleStore

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

Formats the value using the given formatter.

impl Eq for CycleStore

impl PartialEq for CycleStore

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CycleStore