Struct BookmarkStore 

pub struct BookmarkStore { /* private fields */ }

A persisted, named-path bookmark registry.

Loaded from and saved to a bookmarks.toml file in the user’s Trail data directory. Mutations are written immediately after every change.

Internally, bookmarks are a BTreeMap<String, PathBuf> so listing them is always in alphabetical order.

Implementations

impl BookmarkStore

pub fn open(file_path: PathBuf) -> Result<Self, BookmarkError>

Opens the bookmark store from file_path, creating it if absent.

If the file does not exist, an empty store is returned (not an error).

Errors

Returns BookmarkError::Read if the file exists but cannot be read, or BookmarkError::Parse if the TOML is malformed.

pub fn add(&mut self, name: String, path: PathBuf) -> Result<(), BookmarkError>

Adds or replaces a bookmark named name pointing to path.

Persists the updated store immediately.

Errors

Returns a BookmarkError if serialization or the write fails.

pub fn remove(&mut self, name: &str) -> Result<bool, BookmarkError>

Removes the bookmark named name.

Returns true if a bookmark with that name existed and was removed. Persists the updated store even if no entry was removed (idempotent).

Errors

Returns a BookmarkError if serialization or the write fails.

pub fn get(&self, name: &str) -> Option<&Path>

Returns the absolute path for bookmark name, or None if it does not exist.

pub fn list(&self) -> impl Iterator<Item = (&str, &Path)>

Returns an iterator over (name, path) pairs in alphabetical order.

pub fn is_empty(&self) -> bool

Returns true if the store contains no bookmarks.

pub fn len(&self) -> usize

Returns the number of bookmarks in the store.

Trait Implementations

impl Debug for BookmarkStore

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

Formats the value using the given formatter.