Struct Vault 

pub struct Vault<N = NoteInMemory>
where
    N: Note,
{ /* private fields */ }

Represents an entire Obsidian vault

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

Implementations

impl<N> Vault<N>

where N: Note,

pub fn get_duplicates_notes_by_name(&self) -> Vec<&N>

Returns duplicated note name

Performance

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

Other

See have_unique_note_by_name

pub fn have_duplicates_notes_by_name(&self) -> bool

Checks if all note name in the vault are unique

Returns

true if all note name are unique, false otherwise

Performance

Operates in O(n) time for large vaults

Other

See get_duplicates_notes_by_name

impl<N> Vault<N>

where N: Note,

pub fn build_vault( iter: impl Iterator<Item = N>, options: &VaultOptions, ) -> Self

Build vault from iterator

pub fn par_build_vault( iter: impl ParallelIterator<Item = N>, options: &VaultOptions, ) -> Self

where N: Send,

Available on crate feature rayon only.

Build vault from parallel iterator

impl<F> Vault<F>

where F: Note,

pub fn get_digraph(&self) -> Result<DiGraph<&F, ()>, F::Error>

Available on crate feature petgraph only.

Builds directed graph representing note relationships

Edges point from source note to linked note (A → B means A links to B)

Performance Notes

• For vaults with 1000+ notes, enable rayon feature
• Uses NoteOnDisk for minimal memory footprint

Other

See get_ungraph

pub fn par_get_digraph(&self) -> Result<DiGraph<&F, ()>, F::Error>

where F: Send + Sync, F::Error: Send,

Available on crate features petgraph and rayon only.

Parallel builds directed graph representing note relationships

Edges point from source note to linked note (A → B means A links to B)

Performance Notes

• For vaults with 1000+ notes, enable rayon feature
• Uses NoteOnDisk for minimal memory footprint

Other

See par_get_ungraph

pub fn get_ungraph(&self) -> Result<UnGraph<&F, ()>, F::Error>

Available on crate feature petgraph only.

Builds undirected graph showing note connections

Useful for connectivity analysis where direction doesn’t matter

pub fn par_get_ungraph(&self) -> Result<UnGraph<&F, ()>, F::Error>

where F: Send + Sync, F::Error: Send,

Available on crate features petgraph and rayon only.

Parallel builds undirected graph showing note connections

Useful for connectivity analysis where direction doesn’t matter

impl<N> Vault<N>

where N: Note,

pub const fn notes(&self) -> &Vec<N>

Get notes

pub const fn mut_notes(&mut self) -> &mut Vec<N>

Get mutables notes

pub const fn count_notes(&self) -> usize

Get count in notes from vault

pub fn path(&self) -> &Path

Get path to vault

Trait Implementations

impl<N> Clone for Vault<N>

where N: Note + Clone,

fn clone(&self) -> Vault<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<N> Debug for Vault<N>

where N: Note + Debug,

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

Formats the value using the given formatter.

impl<N> Default for Vault<N>

where N: Note + Default,

fn default() -> Vault<N>

Returns the “default value” for a type.

impl<N> PartialEq for Vault<N>

where N: Note + PartialEq,

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

where N: Note + Eq,

impl<N> StructuralPartialEq for Vault<N>

where N: Note,