Struct StdDomainData 

pub struct StdDomainData {
    pub labels: BTreeMap<String, (String, String, String)>,
    pub anonlabels: BTreeMap<String, (String, String)>,
    pub objects: BTreeMap<(String, String), (String, String)>,
    pub progoptions: BTreeMap<(Option<String>, String), (String, String)>,
    pub terms: BTreeMap<String, (String, String)>,
}

Standard-domain (std) registries: cross-reference labels, generic objects (:option:, :envvar:, …), program options, and glossary terms. Field shapes mirror Sphinx’s StandardDomain.data exactly (domains/std/__init__.py:768-781).

Fields

labels: BTreeMap<String, (String, String, String)>

labelname -> (docname, labelid, sectionname).

anonlabels: BTreeMap<String, (String, String)>

labelname -> (docname, labelid).

objects: BTreeMap<(String, String), (String, String)>

(objtype, name) -> (docname, labelid).

progoptions: BTreeMap<(Option<String>, String), (String, String)>

(program, optname) -> (docname, labelid).

terms: BTreeMap<String, (String, String)>

lowercased term -> (docname, labelid).

Implementations

impl StdDomainData

pub fn note_object( &mut self, objtype: &str, name: &str, docname: &str, labelid: &str, ) -> Option<String>

StandardDomain.note_object (:848-864). Returns the docname of a previous description of the same object, which the caller reports as warning [ENV §8 #2] — note Sphinx names the docname here, not doc2path, and offers no :no-index: hint (unlike the py domain).

pub fn note_term( &mut self, term: &str, docname: &str, labelid: &str, ) -> Option<String>

StandardDomain._note_term (:871-878): a glossary term is an object and a lowercased entry in terms, which is what makes :term: resolution case-insensitive.

pub fn add_program_option( &mut self, program: Option<&str>, name: &str, docname: &str, labelid: &str, )

StandardDomain.add_program_option (:995-1000) — first entry wins, unlike every other registry here.

Trait Implementations

impl Clone for StdDomainData

fn clone(&self) -> StdDomainData

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StdDomainData

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

Formats the value using the given formatter.

impl Default for StdDomainData

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for StdDomainData

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for StdDomainData

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for StdDomainData

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StdDomainData