Struct Note

pub struct Note {
    pub name: String,
    pub path: PathBuf,
}

Represents a single note (Markdown file) within a vault.

Fields

name: String

The base filename without .md extension.

path: PathBuf

Filesystem path to the .md file.

Implementations

impl Note

pub fn read_to_string(note: &Note) -> Result<String>

Reads the note’s contents from disk to a String.

Examples

use basalt_core::obsidian::Note;

let note = Note {
    name: "Example".to_string(),
    path: "path/to/Example.md".into(),
};

_ = Note::read_to_string(&note);

pub fn write(note: &Note, contents: String) -> Result<()>

Replaces the content in the notes’ markdown file with the given content.

Examples

use basalt_core::obsidian::Note;

let note = Note {
    name: "Example".to_string(),
    path: "path/to/Example.md".into(),
};

_ = Note::write(&note, String::from("# Heading"));

Trait Implementations

impl Clone for Note

fn clone(&self) -> Note

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Note

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

Formats the value using the given formatter.

impl Default for Note

fn default() -> Note

Returns the “default value” for a type.

impl PartialEq for Note

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