Struct BaseLink 

pub struct BaseLink {
    pub path: String,
    pub display: Option<String>,
}

A wikilink value: a target path plus an optional display label. Produced by the link(...) function, by frontmatter [[wikilinks]], and by file.asLink.

Fields

path: String

The link target as written (e.g. Categories/Books or Books). The .md extension and any [[ ]]/alias are already stripped.

display: Option<String>

Optional display text (link("path", "Display") or [[path|Display]]).

Implementations

impl BaseLink

pub fn new(path: impl Into<String>) -> Self

pub fn with_display(path: impl Into<String>, display: impl Into<String>) -> Self

pub fn basename(&self) -> &str

The path’s final segment without directories or extension — how Obsidian compares links written as full paths vs bare names (link("Categories/Books") matches a note named Books).

pub fn same_target(&self, other: &BaseLink) -> bool

Two links refer to the same note if their basenames match (Obsidian resolves short links by basename) OR one path is a suffix-path of the other.

Trait Implementations

impl Clone for BaseLink

fn clone(&self) -> BaseLink

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BaseLink

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

Formats the value using the given formatter.

impl PartialEq for BaseLink

fn eq(&self, other: &BaseLink) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for BaseLink