Struct GlobalIndex 

pub struct GlobalIndex { /* private fields */ }

In-memory representation of the global index.

Backed by a BTreeMap so iteration order is deterministic (paths sort lexicographically), which keeps secrets list output stable across runs.

Implementations

impl GlobalIndex

pub fn new() -> Self

Build an empty index. Useful for tests and as the default when the on-disk file is absent.

pub fn default_path() -> Result<PathBuf, IndexError>

Resolve the canonical on-disk path (<config-dir>/devboy-tools/secrets/index.toml).

Errors only if dirs::config_dir() returns None.

pub fn load() -> Result<Self, IndexError>

Load the index from the canonical default path.

Returns an empty index if the file does not exist (the global index is opt-in).

pub fn load_from(path: &Path) -> Result<Self, IndexError>

Load the index from a specific path. Returns an empty index if the file does not exist.

pub fn from_toml_str(body: &str) -> Result<Self, IndexError>

Parse the index from a TOML string with no associated path (used in tests and when the caller already has the bytes in memory).

pub fn save_to(&self, path: &Path) -> Result<(), IndexError>

Persist this index to path, creating parent directories as needed. Used by the liveness flow (P9.2 / P9.3) to write upstream-reported expires_at back into the global metadata.

pub fn save(&self) -> Result<PathBuf, IndexError>

Persist to the default path. Returns the path written for the caller’s logging convenience.

pub fn record_expiry(&mut self, path: &SecretPath, expires_at: &str) -> bool

Update entry.expires_at for path. Returns Ok(true) when an entry existed and the field changed; Ok(false) when no entry exists at that path. The caller persists via save / save_to.

Used by the liveness flow (P9.2): a probe that returns LivenessResult::expires_at hands the value here, and the next doctor run sees the freshened expiry.

pub fn record_rotation( &mut self, path: &SecretPath, last_rotated_at: &str, ) -> bool

Update entry.last_rotated_at for path. Same shape as record_expiry; used by the rotation flow (P13.1) after a successful rotation.

pub fn to_toml_string(&self) -> Result<String, Error>

Serialize back to TOML. Round-trips bit-for-bit with what from_toml_str would parse (modulo whitespace and key order — the latter is stable thanks to BTreeMap).

pub fn get(&self, path: &SecretPath) -> Option<&IndexEntry>

Look up a single entry by path.

pub fn insert( &mut self, path: SecretPath, entry: IndexEntry, ) -> Option<IndexEntry>

Insert or replace an entry. Returns the previous entry if any.

pub fn remove(&mut self, path: &SecretPath) -> Option<IndexEntry>

Remove an entry. Returns the removed entry if present.

pub fn len(&self) -> usize

Total number of entries.

pub fn is_empty(&self) -> bool

true when the index has no entries.

pub fn iter(&self) -> impl Iterator<Item = (&SecretPath, &IndexEntry)>

Iterate over (path, entry) pairs in sorted order.

Trait Implementations

impl Clone for GlobalIndex

fn clone(&self) -> GlobalIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GlobalIndex

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

Formats the value using the given formatter.

impl Default for GlobalIndex

fn default() -> GlobalIndex

Returns the “default value” for a type.