Struct NoteOnceCell 

pub struct NoteOnceCell<T = HashMap<String, Value>>
where
    T: Clone + DeserializeOwned,
{ /* private fields */ }

On-disk representation of an Obsidian note file with cache

Warning

It is not thread-safe! Use NoteOnceLock

Implementations

impl<T> NoteOnceCell<T>

where T: DeserializeOwned + Clone,

pub fn set_path(&mut self, path: PathBuf)

Set path to note

Trait Implementations

impl<T> Clone for NoteOnceCell<T>

where T: Clone + DeserializeOwned + Clone,

fn clone(&self) -> NoteOnceCell<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for NoteOnceCell<T>

where T: Clone + DeserializeOwned + Debug,

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

Formats the value using the given formatter.

impl<T> Default for NoteOnceCell<T>

where T: Clone + DeserializeOwned + Default,

fn default() -> NoteOnceCell<T>

Returns the “default value” for a type.

impl<T> Note for NoteOnceCell<T>

where T: DeserializeOwned + Clone,

fn properties(&self) -> Result<Option<Cow<'_, T>>, Error>

Parses YAML frontmatter directly from disk

Errors

• Error::Yaml if properties can’t be deserialized
• Error::IsNotFile If file doesn’t exist
• Error::IO on filesystem error

fn content(&self) -> Result<Cow<'_, str>, Error>

Returns the note’s content body (without frontmatter)

Errors

• Error::IO on filesystem error

Performance

Performs disk read on every call. Suitable for:

• Single-pass processing (link extraction, analysis)
• Large files where in-memory storage is prohibitive

For repeated access, consider caching or NoteInMemory.

fn path(&self) -> Option<Cow<'_, Path>>

Get path to note

type Properties = T

Frontmatter properties type

type Error = Error

Error type

fn note_name(&self) -> Option<String>

Get note name

fn count_words_from_content(&self) -> Result<usize, Self::Error>

Get count words from content

fn count_symbols_from_content(&self) -> Result<usize, Self::Error>

Get count symbols from content

impl<T> NoteFromFile for NoteOnceCell<T>

where T: DeserializeOwned + Clone,

Available on non-target_family=wasm only.

fn from_file(path: impl AsRef<Path>) -> Result<Self, Error>

Creates instance from file

impl<T> PartialEq for NoteOnceCell<T>

where T: Clone + DeserializeOwned + PartialEq,

fn eq(&self, other: &NoteOnceCell<T>) -> 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<T> Eq for NoteOnceCell<T>

where T: Clone + DeserializeOwned + Eq,

impl<T> StructuralPartialEq for NoteOnceCell<T>

where T: Clone + DeserializeOwned,