Enum LinkSite 

pub enum LinkSite {
    Relation {
        field: String,
        index: Option<usize>,
    },
    Body(Range<usize>),
}

Where in a document a forward link is written — a frontmatter relation field or a body wikilink. Carried by every link-resolution finding (prov’s Finding, derived in validate — see StructuralFact) and every CensusEntry so a report can point at the exact site.

Variants

Relation

A frontmatter relation field, by name (e.g. contents, links) and, where the field is a list, by the item’s position in it.

The index is what lets a consumer point at the item rather than the key: a contents list that names the same missing target twice is two findings, and without it nothing in either says which row is which. None for a scalar field (part_of, content) — see Edge::index for how a list is counted.

Fields

field: String

index: Option<usize>

Body(Range<usize>)

A link in the body, at this byte span: a [[…]] wikilink, a markdown/djot [label](target), or the [alt](target) of an ![alt](target) image (the span starts after the !, as BodyLink reports it).

Implementations

impl LinkSite

pub fn field(name: impl Into<String>) -> Self

A relation site for a scalar field — the form every field that is not a list takes (content, manifest, root).

pub fn relation(&self) -> Option<&str>

The relation field this site is in, if it is a frontmatter site.

Trait Implementations

impl Clone for LinkSite

fn clone(&self) -> LinkSite

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LinkSite

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

Formats the value using the given formatter.

impl Display for LinkSite

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

Formats the value using the given formatter.

impl Eq for LinkSite

impl PartialEq for LinkSite

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for LinkSite