Struct ParseLogWarning 

pub struct ParseLogWarning {
    pub source: u16,
    pub message: String,
    pub line: u32,
    pub doc2path_location: bool,
}

One logger.warning a directive raised during the parse.

Producers: Cmdoption.handle_signature’s malformed option description (domains/std/__init__.py:237-245) and — since wave 4.5 — the three literalinclude reader warnings ([INC §3.4]). All are logged with no type/subtype and so render with no [category] suffix.

Fields

source: u16

Source-table index of the location= node’s line: the replay renders this source’s path, not the document’s. Deliberately not #[serde(default)] (cache-shape rule, see RegistryExport::program_options).

message: String

The warning text, already formatted exactly as Sphinx renders it.

line: u32

1-based line of the location= node Sphinx passes.

doc2path_location: bool

When true, the rendered location appends the first source suffix to the source path (see Self::rendered_path). Not #[serde(default)] (cache-shape rule, see RegistryExport::program_options): a pre-wave-4.5 cache entry must MISS, not decode with the flag silently off.

Implementations

impl ParseLogWarning

pub fn rendered_path(&self, source_path: &str) -> String

The path the rendered warning line spells for this record’s source table path.

WHY the doubled suffix: a Sphinx logger.warning(..., location=(source, line)) tuple is treated by the log translator as (docname, lineno) and rendered f'{env.doc2path(docname)}:{lineno}' (SP/util/logging.py:507-512); doc2path on a string that is not a known docname appends the project’s first source suffix (SP/project.py:114-128). The three literalinclude reader warnings pass a full path like <srcdir>/a.rst as the tuple’s source, so Sphinx renders the doubled <srcdir>/a.rst.rst — byte-exact oracle behavior (probed, [INC §3.4]), reproduced here on replay. The appended suffix is the crate’s first source suffix (.rst, matching sphinx’s default source_suffix[0] and this crate’s discovery order).

Trait Implementations

impl Clone for ParseLogWarning

fn clone(&self) -> ParseLogWarning

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParseLogWarning

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ParseLogWarning

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ParseLogWarning

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

where __S: Serializer,

Serialize this value into the given Serde serializer.