Struct ToctreeWarning 

pub struct ToctreeWarning {
    pub source: u16,
    pub line: u32,
    pub message: String,
    pub category: Option<String>,
    pub kind: ToctreeWarningKind,
}

One diagnostic produced while resolving a toctree’s entries.

Carried on the parse record (and therefore through the document cache) rather than logged on the spot: resolution happens inside the parser, which has no warning sink, and a cache hit that skipped the parse must still reproduce the build’s warnings.

Fields

source: u16

Source-table index of the .. toctree:: directive’s line: a toctree written inside an included file warns against THAT file (location=toctree is the node, whose source is the included file’s). Deliberately not #[serde(default)] — the warning rides the document cache, and a pre-provenance record decoding with source 0 would name the includer again (cache-shape rule, crate::rst::RegistryExport::program_options).

line: u32

1-based line of the .. toctree:: directive (Sphinx’s location=toctree), within source.

message: String

The message, formatted exactly as Sphinx formats it.

category: Option<String>

Sphinx’s type.subtype category, or None where Sphinx logs the warning without a type (see crate::error::BuildWarning::category).

kind: ToctreeWarningKind

Trait Implementations

impl Clone for ToctreeWarning

fn clone(&self) -> ToctreeWarning

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToctreeWarning

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToctreeWarning

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ToctreeWarning

impl PartialEq for ToctreeWarning

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ToctreeWarning

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 ToctreeWarning