Struct Note 

pub struct Note {
    pub path: PathBuf,
    pub id: String,
    pub title: Option<String>,
    pub aliases: Vec<String>,
    pub tags: Vec<LocatedTag>,
    pub links: Vec<LocatedLink>,
    pub frontmatter: Option<IndexMap<String, Pod>>,
    pub frontmatter_line_count: usize,
    /* private fields */
}

Fields

path: PathBuf

id: String

title: Option<String>

aliases: Vec<String>

tags: Vec<LocatedTag>

All tags: frontmatter tags have location: Location::Frontmatter; inline tags have location: Location::Inline(...). Always populated.

links: Vec<LocatedLink>

Links extracted from the body at load time (always populated).

frontmatter: Option<IndexMap<String, Pod>>

frontmatter_line_count: usize

Number of lines occupied by the frontmatter block (including delimiters). Used to offset link locations so they reflect positions in the original file.

Implementations

impl Note

pub fn builder(path: impl AsRef<Path>) -> Result<NoteBuilder, NoteError>

pub fn parse(path: impl AsRef<Path>, content: &str) -> Self

Parses a note from a raw file string.

Useful for constructing notes from in-memory strings (e.g. in tests). For file-backed notes prefer Note::from_path.

pub fn from_path(path: impl AsRef<Path>) -> Result<Self, NoteError>

Loads a note from disk, retaining the full contents in Note::text.

Links and inline tags are extracted and stored. Note the entire file is read and retained in memory.

pub fn text(&self) -> &str

The entire, exact contents of the note including frontmatter.

pub fn body(&self) -> &str

The note’s body — its contents with the frontmatter block stripped.

Returned as a zero-copy slice of text.

pub fn update_content( &mut self, body: Option<&str>, frontmatter: Option<IndexMap<String, Pod>>, ) -> Result<(), NoteError>

pub fn reload(self) -> Result<Self, NoteError>

Reloads the note from its path.

pub fn add_alias(&mut self, alias: String) -> Result<(), NoteError>

Add an alias, keeping text in sync.

pub fn add_tag(&mut self, tag: impl Into<String>) -> Result<(), NoteError>

Add a frontmatter tag, keeping text in sync.

pub fn remove_tag(&mut self, tag: &str) -> Result<(), NoteError>

Remove a frontmatter tag, keeping text in sync.

pub fn set_field(&mut self, key: &str, value: &Value) -> Result<(), NoteError>

Set an arbitrary frontmatter field to a value (which can be any YAML type). A null value removes the field from the frontmatter.

pub fn write(&self) -> Result<(), NoteError>

Atomically writes the note to self.path, including serialized frontmatter.

Frontmatter keys are serialized in a deterministic order: id first, then title (if present), then aliases, then tags, then all remaining keys sorted alphabetically.

pub fn write_frontmatter(&self) -> Result<(), NoteError>

Atomically writes the note to self.path, reconstructing the file from the in-memory text. Retained as a distinct entry point for frontmatter-only updates; with text as the source of truth it is equivalent to write.

pub fn read(&self, include_frontmatter: bool) -> Result<String, NoteError>

Read the contents of the note as a string, optionally including frontmatter.

pub fn frontmatter_map(&self) -> IndexMap<String, Pod>

Get the note’s frontmatter map.

pub fn frontmatter_yaml(&self) -> Result<Mapping, Error>

Get the note’s frontmatter map in a form suitable for YAML serialization.

pub fn frontmatter_json(&self) -> Result<Map<String, Value>, NoteError>

Get the note’s frontmatter map in a form suitable for JSON serialization.

pub fn frontmatter_string(&self) -> Result<String, Error>

Get the note’s frontmatter as a YAML string (without delimiters).

pub fn last_modified_time(&self) -> SystemTime

Get the last modified time of the note’s file on disk.

pub fn creation_time(&self) -> SystemTime

Get the creation time of the note.

Trait Implementations

impl Clone for Note

fn clone(&self) -> Note

Returns a duplicate of the value.

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

Performs copy-assignment from source.