Struct NoteStore 

pub struct NoteStore { /* private fields */ }

Review notes, kept in <git common dir>/declutter/notes.json until cleared or posted. A store can be scoped to one review; it then reads and writes only that review’s notes, and leaves the others alone.

Implementations

impl NoteStore

pub fn open(dir: &Path) -> NoteStore

pub fn at(path: PathBuf) -> NoteStore

pub fn in_memory() -> NoteStore

pub fn scoped(self, review: impl Into<String>) -> NoteStore

The same store, seeing only the notes of review.

pub fn notes(&self) -> Vec<&Note>

pub fn export_path(&self) -> Option<PathBuf>

Where exported prompts are written, next to the notes themselves.

pub fn find(&self, path: &str, side: NoteSide, line: usize) -> Option<&Note>

pub fn general(&self) -> Option<&Note>

The note on the change as a whole, if there is one.

pub fn set(&mut self, note: Note) -> Result<()>

Adds or replaces the note on the same line of this review; an empty text removes it.

pub fn add(&mut self, note: Note) -> Result<Added>

Adds a note, putting its text under any note already on that line rather than replacing it. A note that gains text it didn’t have takes the new note’s draft state, so text nobody has read is never posted as read.

pub fn record_posted(&mut self, posted: &[(Note, Link)]) -> Result<()>

Logs these notes as posted, each with where it landed, and drops them from the store.

pub fn posted(&self) -> Vec<Posted>

This review’s posted notes, oldest first.

pub fn clear(&mut self) -> Result<()>

Deletes this review’s notes (every note, when the store is not scoped).

pub fn remove(&mut self, gone: &[Note]) -> Result<()>

Deletes exactly these notes, as after posting them.

pub fn prompt(&self) -> String

The notes as one prompt to hand to a coding agent. Drafts are left out: nobody has read them, so they are no one’s review comments yet.