Struct DerivedReference 

pub struct DerivedReference {
    pub href: String,
    pub text: String,
}

The destination a cross-reference target resolves to on its own, without consulting any catalog.

A target that names a document – another one (an inter-document cross reference) or the current one – carries its own destination. The parser derives it while substituting the reference, rewriting the path with the relfileprefix, relfilesuffix, and outfilesuffix attributes in effect at that point in the document.

This is a default: a ReferenceResolver that knows better (an Antora-style host that resolves targets across a corpus) may still return its own ResolvedReference, which takes precedence. This is what is used when it does not.

Fields

href: String

The hyperlink destination: the rewritten output path plus the target’s fragment, if it had one (e.g. tigers.html#about), or # for a reference to the current document.

text: String

The display text to use when the cross-reference did not supply its own.

For another document this is its output path (e.g. tigers.html), since that document’s reference text is not available to a single-document parse. For the current document it is the document’s reftext or, failing that, its title.

Trait Implementations

impl Clone for DerivedReference

fn clone(&self) -> DerivedReference

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DerivedReference

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

Formats the value using the given formatter.

impl Eq for DerivedReference

impl Hash for DerivedReference

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for DerivedReference

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for DerivedReference