Struct Vault

pub struct Vault<T, F = ObFileOnDisk<T>>
where
    T: DeserializeOwned + Default + Send + Clone,
    F: ObFile<T> + Send + Clone,
{
    pub files: Vec<F>,
    pub path: PathBuf,
    pub phantom: PhantomData<T>,
}

Represents an entire Obsidian vault

Contains all parsed notes and metadata about the vault. Uses ObFileOnDisk by default which is optimized for memory efficiency in large vaults.

Type Parameters

• T: Type for frontmatter properties (must implement DeserializeOwned + Default)
• F: File representation type (ObFileOnDisk recommended for production use)

Fields

files: Vec<F>

All files in the vault

path: PathBuf

Path to vault root directory

phantom: PhantomData<T>

Implementations

impl<T, F> Vault<T, F>

where T: DeserializeOwned + Default + Clone + Send, F: ObFile<T> + Send + Clone,

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

Opens and parses an Obsidian vault

Recursively scans the directory for Markdown files (.md) and parses them. Uses ObFileOnDisk by default which is more memory efficient than ObFileInMemory.

Arguments

• path - Path to the vault directory

Errors

Returns Error if:

• Path doesn’t exist or isn’t a directory

Files that fail parsing are skipped

Memory Considerations

For vaults with 1000+ notes, prefer ObFileOnDisk (default) over ObFileInMemory as it:

1. Uses 90%+ less memory upfront
2. Only loads file content when accessed
3. Scales better for large knowledge bases

pub fn has_unique_filenames(&self) -> bool

Checks if all note filenames in the vault are unique

Critical for graph operations where notes are identified by name. Always run this before calling get_digraph() or get_ungraph().

Returns

true if all filenames are unique, false otherwise

Performance

Operates in O(n log n) time - safe for large vaults

impl Vault<HashMap<String, Value>, ObFileOnDisk>

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

Opens vault using default properties (HashMap) and ObFileOnDisk storage

Recommended for most use cases due to its memory efficiency

Errors

Returns Error if:

• Path doesn’t exist or isn’t a directory

Trait Implementations

impl<T, F> Clone for Vault<T, F>

where T: DeserializeOwned + Default + Send + Clone + Clone, F: ObFile<T> + Send + Clone + Clone,

fn clone(&self) -> Vault<T, F>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T, F> Debug for Vault<T, F>

where T: DeserializeOwned + Default + Send + Clone + Debug, F: ObFile<T> + Send + Clone + Debug,

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

Formats the value using the given formatter.

impl<T, F> Default for Vault<T, F>

where T: DeserializeOwned + Default + Send + Clone + Default, F: ObFile<T> + Send + Clone + Default,

fn default() -> Vault<T, F>

Returns the “default value” for a type.

impl<T, F> PartialEq for Vault<T, F>

where T: DeserializeOwned + Default + Send + Clone + PartialEq, F: ObFile<T> + Send + Clone + PartialEq,

fn eq(&self, other: &Vault<T, F>) -> 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, F> StructuralPartialEq for Vault<T, F>

where T: DeserializeOwned + Default + Send + Clone, F: ObFile<T> + Send + Clone,