Struct ObFileOnDisk

pub struct ObFileOnDisk<T = HashMap<String, Value>>
where
    T: DeserializeOwned + Default + Clone + Send,
{
    pub path: PathBuf,
    /* 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. If files are moved/deleted, calling content() or properties() will panic

Fields

path: PathBuf

Absolute path to the source Markdown file

Trait Implementations

impl<T> Clone for ObFileOnDisk<T>

where T: DeserializeOwned + Default + Clone + Send + 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 + Default + Clone + Send + Debug,

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

Formats the value using the given formatter.

impl<T> Default for ObFileOnDisk<T>

where T: DeserializeOwned + Default + Clone + Send + Default,

fn default() -> ObFileOnDisk<T>

Returns the “default value” for a type.

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

fn content(&self) -> String

Returns the note’s content body (without frontmatter)

Panics

• If file doesn’t exist
• On filesystem errors
• If file contains invalid UTF-8

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) -> T

Parses YAML frontmatter directly from disk

Panics

• If properties can’t be deserialized

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<PathBuf>

Returns the source file path if available

impl<T> PartialEq for ObFileOnDisk<T>

where T: DeserializeOwned + Default + Clone + Send + 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> StructuralPartialEq for ObFileOnDisk<T>

where T: DeserializeOwned + Default + Clone + Send,