Struct PyDomainData 

pub struct PyDomainData {
    pub objects: Vec<(String, PyObjectEntry)>,
    pub objects_index: BTreeMap<String, usize>,
    pub modules: Vec<(String, PyModuleEntry)>,
    pub modules_index: BTreeMap<String, usize>,
}

Python-domain (py) registries: domaindata['py']['objects'] and ['modules'].

INSERTION-ORDERED, not a plain BTreeMap: Sphinx’s fuzzy resolution pass iterates the objects dict in insertion order (__init__.py:901-908) and ambiguity takes the FIRST match, with the candidates listed in match order — lexicographic iteration would diverge on both the resolved target and the warning bytes whenever registration order isn’t alphabetical. Registration order is the docname-ordered merge, record order within a document — and Python dict assignment on an existing key keeps the original insertion slot, so every overwrite here is in place (probe: a :canonical: alias registered between two real definitions keeps its middle slot after the second definition overwrites it).

The side *_index maps give O(log n) exact lookup; they always name the entry’s position in the paired Vec and carry no information of their own.

Fields

objects: Vec<(String, PyObjectEntry)>

fullname -> entry, in registration order.

objects_index: BTreeMap<String, usize>

fullname -> index into Self::objects.

modules: Vec<(String, PyModuleEntry)>

modname -> entry, in registration order.

modules_index: BTreeMap<String, usize>

modname -> index into Self::modules.

Implementations

impl PyDomainData

pub fn note_object( &mut self, name: &str, entry: PyObjectEntry, ) -> Option<String>

PythonDomain.note_object (__init__.py:780-813). Returns the docname of the entry the caller must warn about — Some exactly when Sphinx’s logger.warning fires. The aliased-vs-real matrix (each cell probe-verified against sphinx 9.1.0):

existing \ new	real	aliased
real	warn + overwrite	silent keep (no write)
aliased	silent overwrite	warn + overwrite

Overwrites land in place (Python dict assignment keeps the original insertion slot).

pub fn note_module(&mut self, name: &str, entry: PyModuleEntry)

PythonDomain.note_module (__init__.py:819-832) — an unconditional dict assignment: never warns, last value wins, an existing name keeps its insertion slot. (The duplicate-module warning comes from the note_object(modname, 'module', ...) call PyModule.run makes alongside this one.)

pub fn clear_doc(&mut self, docname: &str)

PythonDomain.clear_doc (__init__.py:744-751): drop every entry the document owns. Survivors keep their relative order — deleting from a Python dict never reorders what stays — and the indices are rebuilt to match.

pub fn merge(&mut self, other: &PyDomainData, docnames: &BTreeSet<String>)

PythonDomain.merge_domaindata (__init__.py:753-757): fold in other’s entries whose docname is in docnames, in other’s registration order. Like Sphinx’s, this is a plain dict assignment per entry — no duplicate checks (“XXX check duplicates?”), an existing name is overwritten in place, a new one appended.

Trait Implementations

impl Clone for PyDomainData

fn clone(&self) -> PyDomainData

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PyDomainData

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

Formats the value using the given formatter.

impl Default for PyDomainData

fn default() -> PyDomainData

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PyDomainData

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for PyDomainData

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for PyDomainData

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 PyDomainData