Struct Vault 

pub struct Vault {
    pub root: PathBuf,
    pub notes: Vec<Note>,
    pub folders: Vec<String>,
}

Every note of a vault, with what links where.

Fields

root: PathBuf

notes: Vec<Note>

folders: Vec<String>

Every folder, empty ones too: “admin”, “admin/letters”.

Implementations

impl Vault

pub fn open(root: &Path) -> Vault

Reads every Markdown file under root, and lists the pictures, PDFs and sounds beside them; hidden folders and tools’ own are skipped.

fn resolve_all(&mut self)

Links to notes, made into vault paths: “wiki:letters” and “../admin/letters.md” → “sioul:note/admin/letters.md”.

pub fn resolve(&self, folder: &str, target: &str) -> Option<String>

The vault path a link from a note in folder points at, when it is a note.

fn by_name(&self, folder: &str, name: &str) -> Option<String>

Obsidian’s rule for [[name]]: a path that ends with it, the same folder first, then the shortest path; an alias otherwise.

pub fn note(&self, path: &str) -> Option<&Note>

pub fn backlinks(&self, path: &str) -> Vec<(&Note, &NoteLink)>

The notes that link to this one, with the line of each link.

pub fn search(&self, query: &str) -> Vec<&Note>

The notes whose title, path or tags hold every word of query, case and accents ignored.

pub fn with_links(&self, folder: &str, body: &str) -> String

A note’s Markdown with its [[wikilinks]] made ordinary links to the notes they find (sioul:note/…), so they can be rendered and followed; one that finds nothing stays as typed. Code is left alone.

fn picture(&self, path: &str) -> String

A picture of the vault as HTML, at most 560 pixels wide.

pub fn file(&self, path: &str) -> Option<PathBuf>

Where a note’s file is.

Trait Implementations

impl Clone for Vault

fn clone(&self) -> Vault

Returns a duplicate 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.