Enum ExternalRole 

pub enum ExternalRole {
    Xref {
        inventory: Option<String>,
        domain: String,
        role: String,
    },
    Failed(Diagnostic),
}

What the parse layer should build for an :external:...: role.

Variants

Xref

Emit a pending_xref for domain:role, stamped with inventory.

Fields

inventory: Option<String>

domain: String

role: String

Failed(Diagnostic)

Emit nothing, and report this once the build can locate it. Sphinx’s role returns ([], []) on every one of these (_resolve.py:386-463).

Trait Implementations

impl Clone for ExternalRole

fn clone(&self) -> ExternalRole

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExternalRole

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

Formats the value using the given formatter.

impl Eq for ExternalRole

impl PartialEq for ExternalRole

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ExternalRole