Struct XrefRequest 

pub struct XrefRequest<'a> {
    pub fromdoc: &'a str,
    pub refdoc: &'a str,
    pub reftype: &'a str,
    pub reftarget: &'a str,
    pub refexplicit: bool,
    pub program: Option<&'a str>,
    pub contnode_text: &'a str,
}

One pending_xref to resolve — the attributes Sphinx’s resolvers read off the node.

Fields

fromdoc: &'a str

The document being resolved (Sphinx’s fromdocname).

refdoc: &'a str

pending_xref['refdoc']: the document the reference was written in, which is what a relative :doc: target resolves against. Equal to fromdoc unless the node was copied in from an include.

reftype: &'a str

reftarget: &'a str

refexplicit: bool

program: Option<&'a str>

pending_xref['std:program']: the .. program:: in scope where the :option: reference was written.

contnode_text: &'a str

contnode.astext() — the text the parse layer put in the reference.

Trait Implementations

impl<'a> Clone for XrefRequest<'a>

fn clone(&self) -> XrefRequest<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for XrefRequest<'a>