Struct UserMetadataIndex 

pub struct UserMetadataIndex { /* private fields */ }

User metadata index providing atomic access to alias and history storage.

This struct manages two storage locations:

• Global: ~/.config/sqry/global.index.user for cross-project aliases
• Local: .sqry-index.user in project root for project-specific aliases

All operations are atomic (using temp file + rename) and thread-safe.

Implementations

impl UserMetadataIndex

pub fn open( project_root: Option<&Path>, config: PersistenceConfig, ) -> Result<Self>

Open or create a user metadata index.

Arguments

• project_root - Project root for local storage. Pass None for global-only mode.
• config - Persistence configuration.

Errors

Returns an error if the global config directory cannot be created.

pub fn path_for_scope(&self, scope: StorageScope) -> Result<PathBuf>

Get the file path for a storage scope.

Errors

Returns an error if the global config directory cannot be determined.

pub fn load(&self, scope: StorageScope) -> Result<UserMetadata>

Load metadata from a storage scope.

Returns default metadata if the file doesn’t exist yet.

Errors

Returns an error if the file exists but cannot be read or parsed.

pub fn save(&self, scope: StorageScope, metadata: &UserMetadata) -> Result<()>

Save metadata to a storage scope.

Uses atomic write (temp file + rename) to prevent corruption.

Errors

Returns an error if the file cannot be written.

pub fn update<F>(&self, scope: StorageScope, f: F) -> Result<()>

where F: FnOnce(&mut UserMetadata) -> Result<()>,

Atomically update metadata using a closure.

This is the preferred method for modifications as it handles the read-modify-write cycle atomically.

Errors

Returns an error if loading or saving fails, or if the closure returns an error.

pub fn index_size(&self, scope: StorageScope) -> Result<u64>

Get the size of the index file for a scope in bytes.

Returns 0 if the file doesn’t exist.

Errors

Returns an error if the path cannot be determined.

pub fn needs_rotation(&self, scope: StorageScope) -> Result<bool>

Check if the index needs rotation based on size.

Errors

Returns an error if the index size cannot be determined.

pub fn invalidate_cache(&self, scope: StorageScope)

Invalidate the cache for a scope.

Forces the next load to read from disk.

pub fn invalidate_all_caches(&self)

Invalidate all caches.

pub fn has_project_root(&self) -> bool

Check if a project root is set for local storage.

pub fn project_root(&self) -> Option<&Path>

Get the project root if set.

pub fn config(&self) -> &PersistenceConfig

Get a reference to the configuration.

Trait Implementations

impl Debug for UserMetadataIndex

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

Formats the value using the given formatter.