Struct Vault

pub struct Vault {
    pub name: String,
    pub path: PathBuf,
    pub open: bool,
    pub ts: u64,
}

Represents a single Obsidian vault.

A vault is a folder containing notes and other metadata.

Fields

name: String

The name of the vault, inferred from its directory name.

path: PathBuf

Filesystem path to the vault’s directory.

open: bool

Whether the vault is marked ‘open’ by Obsidian.

ts: u64

Timestamp of last update or creation.

Implementations

impl Vault

pub fn notes(&self) -> Vec<Note>

Returns a Vec of Markdown (.md) files in this vault as Note structs.

Examples

use basalt_core::obsidian::{Vault, Note};

let vault = Vault {
    name: "MyVault".into(),
    path: "path/to/my_vault".into(),
    ..Default::default()
};

assert_eq!(vault.notes(), vec![]);

pub fn notes_sorted_by( &self, compare: impl Fn(&Note, &Note) -> Ordering, ) -> Vec<Note>

Returns a sorted vector Vec<Note> of all notes in the vault, sorted according to the provided comparison function.

Examples

use std::cmp::Ordering;
use basalt_core::obsidian::{Vault, Note};

let vault = Vault {
    name: "MyVault".to_string(),
    path: "path/to/my_vault".into(),
    ..Default::default()
};

let alphabetically = |a: &Note, b: &Note| a.name.to_lowercase().cmp(&b.name.to_lowercase());

_ = vault.notes_sorted_by(alphabetically);

Trait Implementations

impl Clone for Vault

fn clone(&self) -> Vault

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Vault

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

Formats the value using the given formatter.

impl Default for Vault

fn default() -> Vault

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Vault

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Vault

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