Struct PyModuleRecord 

pub struct PyModuleRecord {
    pub name: String,
    pub node_id: String,
    pub synopsis: String,
    pub platform: String,
    pub deprecated: bool,
    pub source: u16,
    pub lineno: u32,
}

One PythonDomain.note_module call (PyModule.run, domains/python/__init__.py:515-521) — the modname → ModuleEntry registration feeding the env layer and, later, the py-modindex.

Fields

name: String

node_id: String

module-<name> (or its module-<n> collision serial).

synopsis: String

:synopsis: option, '' when absent. (A bare :synopsis: with no value is Python None in sphinx’s identity-lambda option spec; it is recorded as '' here — probe module_synopsis_bare.)

platform: String

:platform: option, '' when absent.

deprecated: bool

:deprecated: flag.

source: u16

Source-table index of the directive. Deliberately not #[serde(default)] (cache-shape rule, see RegistryExport::program_options).

lineno: u32

1-based line of the directive marker.

Trait Implementations

impl Clone for PyModuleRecord

fn clone(&self) -> PyModuleRecord

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PyModuleRecord

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PyModuleRecord

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PyModuleRecord

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

where __S: Serializer,

Serialize this value into the given Serde serializer.