Struct Note 

pub struct Note {
    pub properties: BTreeMap<String, Value>,
    pub name: String,
    pub basename: String,
    pub path: String,
    pub folder: String,
    pub ext: String,
    pub size: u64,
    pub ctime: Option<BaseDate>,
    pub mtime: Option<BaseDate>,
    pub tags: Vec<String>,
    pub links: Vec<BaseLink>,
    pub slug: String,
}

One note (markdown file) in the vault, queryable by a base.

Fields

properties: BTreeMap<String, Value>

Frontmatter properties, keyed by name, coerced to typed values. Accessed via note.<name> or a bare <name> in expressions.

name: String

file.name — filename with extension (e.g. Intro.md).

basename: String

file.basename — filename without extension.

path: String

file.path — full vault-relative path (e.g. guide/Intro.md).

folder: String

file.folder — containing folder path (empty for root).

ext: String

file.ext — extension without the dot (md).

size: u64

file.size — byte length of the source file.

ctime: Option<BaseDate>

file.ctime — creation time, if known.

mtime: Option<BaseDate>

file.mtime — modification time, if known.

tags: Vec<String>

file.tags — all #tags (frontmatter + body), without the leading #.

links: Vec<BaseLink>

file.links — outbound internal link targets.

slug: String

The doc’s site slug (docgen-specific; used to build the cell hyperlink to the rendered page). Not exposed as a base property.

Implementations

impl Note

pub fn file_property(&self, field: &str) -> Value

Resolve a file.<field> access to a value. Unknown fields → Null.

pub fn note_property(&self, name: &str) -> Value

Resolve a bare/note. property. Unknown → Null.

pub fn has_tag(&self, want: &str) -> bool

Whether this note has any of tags (Obsidian’s file.hasTag matches a tag or any of its parents: a note tagged #a/b matches hasTag("a")).

pub fn in_folder(&self, folder: &str) -> bool

Whether this note lives in folder or any subfolder of it.

pub fn has_link(&self, target: &BaseLink) -> bool

Whether this note links to target (by basename/path).

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.

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.