NoteAliases

Trait NoteAliases 

Source
pub trait NoteAliases: Note {
    // Required method
    fn aliases(&self) -> Result<Vec<String>, Self::Error>;

    // Provided methods
    fn count_aliases(&self) -> Result<usize, Self::Error> { ... }
    fn have_aliases(&self) -> Result<bool, Self::Error> { ... }
}
Expand description

Getting aliases from note

§Example

use obsidian_parser::prelude::*;

let raw_text = "---\ntags:\n- todo\n---\nSameData";
let note = NoteInMemory::from_string(raw_text).unwrap();

let aliases = note.aliases().unwrap();
assert!(aliases.is_empty());

Required Methods§

Source

fn aliases(&self) -> Result<Vec<String>, Self::Error>

Get aliases from note

§Example
use obsidian_parser::prelude::*;

let raw_text = "---\ntags:\n- todo\n---\nSameData";
let note = NoteInMemory::from_string(raw_text).unwrap();

let aliases = note.aliases().unwrap();
assert!(aliases.is_empty());

Provided Methods§

Source

fn count_aliases(&self) -> Result<usize, Self::Error>

Get count aliases from note

§Example
use obsidian_parser::prelude::*;

let raw_text = "---\naliases:\n- my_alias\n---\nSameData";
let note = NoteInMemory::from_string(raw_text).unwrap();

let count_aliases = note.count_aliases().unwrap();
assert_eq!(count_aliases, 1);
Source

fn have_aliases(&self) -> Result<bool, Self::Error>

Have aliases in note?

§Example
use obsidian_parser::prelude::*;

let raw_text = "---\naliases:\n- my_alias\n---\nSameData";
let note = NoteInMemory::from_string(raw_text).unwrap();

let have_aliases = note.have_aliases().unwrap();
assert!(have_aliases);

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors§

Source§

impl<N> NoteAliases for N
where N: Note<Properties = HashMap<String, Value>>, N::Error: From<Error>,