Struct IndexMessage 

pub struct IndexMessage {
    pub docname: String,
    pub message: String,
}

A diagnostic create_index raises, located at a whole document (location=docname, which renders as the source path with no line).

Fields

docname: String

message: String

Implementations

impl IndexMessage

pub fn into_warning(self, path: &Path) -> BuildWarning

Render as the [index]-categorized build warning Sphinx logs.

Trait Implementations

impl Clone for IndexMessage

fn clone(&self) -> IndexMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IndexMessage

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

Formats the value using the given formatter.

impl Eq for IndexMessage

impl PartialEq for IndexMessage

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for IndexMessage