Struct Annotations 

pub struct Annotations {
    pub version: u32,
    pub path: String,
    pub notes: BTreeMap<String, Note>,
}

Fields

version: u32

path: String

Canonical absolute path of the session file these annotations belong to. Recorded for reference / portability — the disk-side filename is derived via annotations_file_for.

notes: BTreeMap<String, Note>

Step index (0-based, as a JSON-string per the format) → note. BTreeMap keeps iteration order stable for the list overlay in follow-up work.

Implementations

impl Annotations

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

Fresh, empty annotations bound to the given session path.

pub fn is_empty(&self) -> bool

True when no notes are stored. Used by the export integrations to skip emitting a “notes” section and by tests.

pub fn get(&self, step_idx: usize) -> Option<&Note>

Get the note for a step index, if any.

pub fn has(&self, step_idx: usize) -> bool

True when the given step index has an annotation.

pub fn set(&mut self, step_idx: usize, text: &str) -> bool

Upsert a note. Empty / whitespace-only text deletes the entry (the intuitive “clear the annotation” behavior). Returns true when the set changed anything.

pub fn iter(&self) -> impl Iterator<Item = (usize, &Note)>

Iterate notes in numeric step-index order. BTreeMap iterates string keys lexicographically, which would put “12” before “2”; we collect and re-sort by the parsed usize instead. Consumed by the TUI A list overlay and by the export writers (md / html / json) for their per-step note sections.

pub fn load_for(session_path: &Path) -> Self

Load annotations for a session from disk. Returns an empty set (not an error) when the file doesn’t exist — the common case for sessions the user hasn’t annotated yet.

A corrupted / malformed notes file also returns empty rather than erroring, so one bad file doesn’t prevent the TUI from launching. A stderr warning is emitted so users know to look.

pub fn save_for(&self, session_path: &Path) -> Result<PathBuf>

Write to disk atomically: serialize to a sibling *.tmp, then rename. rename(2) is atomic on the same filesystem, so partial writes never corrupt an existing notes file.

Trait Implementations

impl Clone for Annotations

fn clone(&self) -> Annotations

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Annotations

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

Formats the value using the given formatter.

impl Default for Annotations

fn default() -> Annotations

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Annotations

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Annotations

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.