Struct ObFileOnDisk 

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

On-disk representation of an Obsidian note file

Optimized for vault operations where:

1. Memory efficiency is critical (large vaults)
2. Storage is fast (SSD/NVMe)
3. Content is accessed infrequently

Tradeoffs vs ObFileInMemory

Characteristic	ObFileOnDisk	ObFileInMemory
Memory usage	Minimal (~24 bytes)	High (content + properties)
File access	On-demand	Preloaded
Best for	SSD-based vaults	RAM-heavy workflows
Content access cost	Disk read	Zero cost

Recommendation

Prefer ObFileOnDisk for vault operations on modern hardware. The combination of SSD speeds and Rust’s efficient I/O makes this implementation ideal for:

• Large vaults (1000+ files)
• Graph processing

Warning

Requires persistent file access throughout the object’s lifetime

Trait Implementations

impl<T> Clone for ObFileOnDisk<T>

where T: DeserializeOwned + Clone + Clone,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for ObFileOnDisk<T>

where T: DeserializeOwned + Clone + Debug,

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

Formats the value using the given formatter.

impl<T> Default for ObFileOnDisk<T>

where T: DeserializeOwned + Clone + Default,

fn default() -> ObFileOnDisk<T>

Returns the “default value” for a type.

impl<T: DeserializeOwned + Clone> ObFile<T> for ObFileOnDisk<T>

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

Returns the note’s content body (without frontmatter)

Errors

• If file doesn’t exist
• On filesystem errors

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 ObFileInMemory.

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

Parses YAML frontmatter directly from disk

Errors

• If properties can’t be deserialized
• If file doesn’t exist
• On filesystem errors

fn from_string<P: AsRef<Path>>( _raw_text: &str, path: Option<P>, ) -> Result<Self, Error>

Creates instance from text (requires path!)

Dont use this function. Use from_file

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

Creates instance from path

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

Returns the source file path if available

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

Get note name

impl<T: DeserializeOwned + Serialize + Clone> ObFileFlush<T> for ObFileOnDisk<T>

fn flush_content(&self, open_option: &OpenOptions) -> Result<(), Error>

Flush only content

fn flush_properties(&self, open_option: &OpenOptions) -> Result<(), Error>

Flush only content

fn flush(&self, open_option: &OpenOptions) -> Result<(), Error>

Flush ObFile to [self.path()]

impl<T> PartialEq for ObFileOnDisk<T>

where T: DeserializeOwned + Clone + PartialEq,

fn eq(&self, other: &ObFileOnDisk<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 ObFileOnDisk<T>

where T: DeserializeOwned + Clone + Eq,

impl<T> StructuralPartialEq for ObFileOnDisk<T>

where T: DeserializeOwned + Clone,