Enum WarningSeverity 

#[non_exhaustive]
pub enum WarningSeverity {
    Debug,
    Warning,
}

The severity of a Warning.

Every diagnostic this parser records is surfaced through Document::warnings regardless of severity; a host filters on this value to decide which diagnostics to act on. The variants are ordered from least to most severe, so a host can select “at or above” a threshold with an ordinary comparison – for example, keeping only entries where warning.severity >= WarningSeverity::Warning suppresses the low-severity Debug diagnostics.

A warning’s severity is an intrinsic property of its WarningType; it is assigned when the warning is constructed and never varies from one occurrence of a given type to another.

This enum is non_exhaustive: further severities may be recognized as the parser grows, so a host matching on it needs a catch-all arm.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Debug

A low-severity diagnostic that a host is expected to suppress by default. It reports something a host may wish to observe (for example, via tooling or a verbose mode) but which does not, on its own, suggest the parse result is wrong. Asciidoctor logs the equivalent messages below its default WARN threshold.

Warning

A condition where the parse result might be unexpected. This is the severity of the overwhelming majority of this parser’s diagnostics and the level a host should surface by default.

Trait Implementations

impl Clone for WarningSeverity

fn clone(&self) -> WarningSeverity

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for WarningSeverity

impl Debug for WarningSeverity

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

Formats the value using the given formatter.

impl Eq for WarningSeverity

impl Hash for WarningSeverity

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for WarningSeverity

fn cmp(&self, other: &WarningSeverity) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for WarningSeverity

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for WarningSeverity

fn partial_cmp(&self, other: &WarningSeverity) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for WarningSeverity