Struct LinkEdge 

pub struct LinkEdge {
    pub relation: Option<String>,
    pub path: String,
}

One link between two documents, named by the relation that carries it.

A vault declares its own relations — sequel, translation_of, author, whatever its configuration says — so the name is data, never something this crate knows. Nothing here may hardcode a vocabulary: whatever names arrive are the names a template can address.

relation is None for a link written in prose, which has no name to be filed under. Those reach a template through backlinks, the flat union, and nowhere else — a reserved key for them would collide with a relation a vault is entitled to declare.

path is the document at the far end, spelled as SourceDoc::path spells it — the same coordinates, so an edge can be matched to the page it names without either side re-deriving the other’s naming rule.

Fields

relation: Option<String>

The relation this edge is written in, or None for a body link.

path: String

The document at the far end.

Trait Implementations

impl Clone for LinkEdge

fn clone(&self) -> LinkEdge

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LinkEdge

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

Formats the value using the given formatter.

impl Eq for LinkEdge

impl Ord for LinkEdge

fn cmp(&self, other: &LinkEdge) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for LinkEdge

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for LinkEdge

fn partial_cmp(&self, other: &LinkEdge) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for LinkEdge