Struct KnowledgeShelf 

pub struct KnowledgeShelf { /* private fields */ }

Local knowledge shelf store.

Implementations

impl KnowledgeShelf

pub fn new() -> Self

Creates an empty shelf.

pub fn upsert(&mut self, record: ShelfRecord)

Inserts or replaces a shelf record.

pub fn get(&self, id: &str) -> Option<&ShelfRecord>

Returns a shelf record.

pub fn get_mut(&mut self, id: &str) -> Option<&mut ShelfRecord>

Returns a mutable shelf record.

pub fn iter(&self) -> impl Iterator<Item = &ShelfRecord>

Iterates records in deterministic id order.

pub fn search<F>(&self, query: &str, markdown_for: F) -> Vec<ShelfSearchResult>

where F: FnMut(&ShelfRecord) -> Option<String>,

Searches shelf metadata and caller-provided Markdown exports.

The markdown_for callback lets hosts load exported Markdown from local storage without making index-core perform filesystem IO.

pub fn save_to_path(&self, path: impl AsRef<Path>) -> Result<(), ShelfError>

Saves the shelf to disk.

pub fn load_from_path(path: impl AsRef<Path>) -> Result<Self, ShelfError>

Loads a shelf from disk. Missing shelves are treated as empty shelves.

Trait Implementations

impl Clone for KnowledgeShelf

fn clone(&self) -> KnowledgeShelf

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KnowledgeShelf

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

Formats the value using the given formatter.

impl Default for KnowledgeShelf

fn default() -> KnowledgeShelf

Returns the “default value” for a type.

impl PartialEq for KnowledgeShelf

fn eq(&self, other: &KnowledgeShelf) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for KnowledgeShelf

impl StructuralPartialEq for KnowledgeShelf