Enum XrefOutcome 

pub enum XrefOutcome {
    Resolved(ResolvedXref),
    Kept {
        warning: Option<String>,
    },
    Missing,
}

What resolution did with a reference. Sphinx expresses these three as “returned a node” / “returned the contnode” / “returned None”: the middle case still counts as resolved to the caller, which is why a :numref: that gives up never also raises a dangling-reference warning.

Variants

Resolved(ResolvedXref)

A reference node replaces the pending_xref.

Kept

The content node stays in place. warning is the diagnostic the resolver logged on its way out (numref’s #10-#13), which carries no type/subtype and so renders with no [category] suffix.

Fields

warning: Option<String>

Missing

Nothing found: the caller decides whether this warrants a dangling-reference warning.

Trait Implementations

impl Debug for XrefOutcome

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

Formats the value using the given formatter.

impl PartialEq for XrefOutcome

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for XrefOutcome