Struct NotesManager 

pub struct NotesManager { /* private fields */ }

Manager for ADR operations in git notes.

Implementations

impl NotesManager

pub const fn new(git: Git, config: AdrConfig) -> Self

Create a new NotesManager.

pub const fn git(&self) -> &Git

Get a reference to the Git wrapper.

pub const fn config(&self) -> &AdrConfig

Get a reference to the configuration.

pub fn list(&self) -> Result<Vec<Adr>, Error>

List all ADRs.

Errors

Returns an error if ADRs cannot be listed.

pub fn get(&self, id: &str) -> Result<Adr, Error>

Get an ADR by ID.

Errors

Returns an error if the ADR is not found or cannot be read.

pub fn get_by_commit(&self, commit: &str) -> Result<Adr, Error>

Get an ADR by commit hash.

Errors

Returns an error if the ADR is not found.

pub fn create(&self, adr: &Adr) -> Result<(), Error>

Create a new ADR.

Errors

Returns an error if the ADR cannot be created.

pub fn update(&self, adr: &Adr) -> Result<(), Error>

Update an existing ADR.

Errors

Returns an error if the ADR cannot be updated.

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

Delete an ADR.

Errors

Returns an error if the ADR cannot be deleted.

pub fn next_number(&self) -> Result<u32, Error>

Get the next available ADR number.

Errors

Returns an error if ADRs cannot be listed.

pub fn format_id(&self, number: u32) -> String

Generate an ADR ID for the given number.

pub fn sync(&self, remote: &str, push: bool, fetch: bool) -> Result<(), Error>

Sync notes with remote.

Errors

Returns an error if sync fails.

Trait Implementations

impl Debug for NotesManager

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

Formats the value using the given formatter.