Struct FsStore 

pub struct FsStore { /* private fields */ }

Filesystem-shaped Store implementation rooted at <root>.

Implementations

impl FsStore

pub fn new(root: Utf8PathBuf) -> Result<Self, StoreError>

Open or create a store at root.

Creates <root>/ and <root>/.metadata/ if missing. On POSIX, both directories are created with mode 0700 (owner-only). On Windows, directory ACLs are inherited (no-op).

Errors

Returns StoreError::Io if root exists but is not a directory, or if directory creation fails.

pub fn root(&self) -> &Utf8Path

Returns the store root.

pub fn search_by_tag( &self, tag: &str, query: &str, limit: usize, ) -> Result<Vec<EntryInfo>, StoreError>

Return up to limit entries whose [doiget].tags list contains tag (case-sensitive exact match). If query is non-empty, also apply a case-insensitive substring filter over title / authors / venue / publisher. An empty query matches all tagged entries.

Trait Implementations

impl Clone for FsStore

fn clone(&self) -> FsStore

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FsStore

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

Formats the value using the given formatter.

impl Store for FsStore

fn search( &self, query: &str, limit: usize, ) -> Result<Vec<EntryInfo>, StoreError>

Phase 1 search is a linear scan over all metadata files. Phase 2 will add a tantivy / sqlite-fts index when the corpus grows past the point where O(N) per query becomes noticeable in CLI latency.

fn read(&self, key: &Safekey) -> Result<Option<Metadata>, StoreError>

Read the entry keyed by key.

fn write( &self, key: &Safekey, m: &Metadata, pdf: Option<&Utf8Path>, ) -> Result<(), StoreError>

Write or update the entry keyed by key.

fn write_user_authored( &self, key: &Safekey, m: &Metadata, pdf: Option<&Utf8Path>, ) -> Result<(), StoreError>

Write on behalf of a caller that DID author the user fields, so an empty tags / collections or a None annotation means exactly that (UserFields::Authored). doiget tag / doiget annotate only.

fn list_recent(&self, limit: usize) -> Result<Vec<EntryInfo>, StoreError>

Return up to limit entries, most-recent first by [doiget].fetched_at.