Struct Intersphinx 

pub struct Intersphinx {
    pub data: IntersphinxData,
    pub disabled_reftypes: BTreeSet<String>,
    pub resolve_self: String,
}

The loaded inventories plus the two configuration values resolution consults.

Fields

data: IntersphinxData

disabled_reftypes: BTreeSet<String>

intersphinx_disabled_reftypes, default ['std:doc'].

resolve_self: String

intersphinx_resolve_self, default '' (disabled).

Implementations

impl Intersphinx

pub fn is_empty(&self) -> bool

pub fn resolve_detect( &self, query: &XrefQuery<'_>, diagnostics: &mut Vec<Diagnostic>, ) -> HookOutcome

resolve_reference_detect_inventory (_resolve.py:305-340) — what the missing-reference event calls.

Tries the merged inventory with the target as written, then splits the target on its first : into inv_name:target and retries inside that named inventory. The prefixed form deliberately bypasses intersphinx_disabled_reftypes.

pub fn resolve_in_inventory( &self, inv_name: &str, query: &XrefQuery<'_>, diagnostics: &mut Vec<Diagnostic>, ) -> Option<Resolution>

resolve_reference_in_inventory (_resolve.py:258-277): an explicit inventory never honours the disabled reftypes.

pub fn resolve_any( &self, honor_disabled: bool, query: &XrefQuery<'_>, diagnostics: &mut Vec<Diagnostic>, ) -> Option<Resolution>

resolve_reference_any_inventory (_resolve.py:280-302).

Trait Implementations

impl Clone for Intersphinx

fn clone(&self) -> Intersphinx

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Intersphinx

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

Formats the value using the given formatter.

impl Default for Intersphinx

fn default() -> Intersphinx

Returns the “default value” for a type.