Struct PyXrefTarget 

pub struct PyXrefTarget<'a> {
    pub docname: &'a str,
    pub node_id: &'a str,
    pub reftitle: String,
    pub is_module: bool,
}

A resolved py cross-reference: what the resolver needs to build the reference node make_refnode / _make_module_refnode would.

Fields

docname: &'a str

node_id: &'a str

reftitle: String

make_refnode’s title: the matched fullname, or for modules {name}[: {synopsis}][ (deprecated)][ ({platform})] — deprecated BEFORE platform (_make_module_refnode, :1039-1054; probe: a module with all three shows both: Some synopsis. (deprecated) (Unix, Windows)).

is_module: bool

A module target keeps the content node even when the pending_xref carries pending_xref_condition children (:983-984 passes contnode straight through).

Trait Implementations

impl<'a> Debug for PyXrefTarget<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for PyXrefTarget<'a>

fn eq(&self, other: &PyXrefTarget<'a>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<'a> StructuralPartialEq for PyXrefTarget<'a>