Enum ToctreeWarningKind 

pub enum ToctreeWarningKind {
    MissingDocument,
    EmptyGlob,
    DuplicateEntry,
    PatternError,
}

What kind of toctree diagnostic this is, kept alongside the Sphinx message so the builder can map it onto its own coarse crate::error::WarningType.

Variants

MissingDocument

An entry naming a document that is excluded or absent.

EmptyGlob

A :glob: pattern that matched nothing.

DuplicateEntry

A document already claimed by an earlier entry.

PatternError

Not a Sphinx diagnostic: a :glob: pattern this crate could not compile. Python’s fnmatch cannot fail, so Sphinx has no equivalent — but silently treating the pattern as matching nothing would hide a real bug behind an empty_glob warning.

Trait Implementations

impl Clone for ToctreeWarningKind

fn clone(&self) -> ToctreeWarningKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ToctreeWarningKind

impl Debug for ToctreeWarningKind

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToctreeWarningKind

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ToctreeWarningKind

impl PartialEq for ToctreeWarningKind

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ToctreeWarningKind

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 ToctreeWarningKind