Enum Error 

#[non_exhaustive]
pub enum Error {
    InvalidIncludePath(Box<SourceLocation>, PathBuf),
    InvalidLineRange(Box<SourceLocation>, String),
    Parse(Box<SourceLocation>, String),
    PegParse(Box<SourceLocation>, String),
    ParseGrammar(ParseError<LineCol>),
    NestedSectionLevelMismatch(Box<SourceLocation>, u8, u8),
    MismatchedDelimiters(Box<SourceLocation>, String),
    InvalidAdmonitionVariant(Box<SourceLocation>, String),
    InvalidConditionalDirective(Box<SourceLocation>),
    InvalidIncludeDirective(Box<SourceLocation>, String),
    InvalidIndent(Box<SourceLocation>, String),
    IncludeIndentTooLarge(Box<SourceLocation>, usize, usize),
    InvalidLevelOffset(Box<SourceLocation>, String),
    InvalidDocumentAttribute {
        name: String,
        value: String,
        expected: &'static str,
        location: Option<Box<SourceLocation>>,
    },
    Io(Error),
    IncludeSource(IncludeSourceError),
    IncludeSourceTooLarge(String),
    IncludeExpansionTooLarge(Box<SourceLocation>, usize),
    IncludeSelectionTooComplex(String),
    Url(ParseError),
    ParseInt(ParseIntError),
    InvalidIfEvalDirectiveMismatchedTypes(Box<SourceLocation>),
    UnknownEncoding(String),
    UnrecognizedEncodingInFile(String),
    NetworkDisabled,
    TryFromIntError(TryFromIntError),
    NonConformingManpageTitle(Box<SourceLocation>, String),
}

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.

InvalidIncludePath(Box<SourceLocation>, PathBuf)

InvalidLineRange(Box<SourceLocation>, String)

Parse(Box<SourceLocation>, String)

PegParse(Box<SourceLocation>, String)

ParseGrammar(ParseError<LineCol>)

NestedSectionLevelMismatch(Box<SourceLocation>, u8, u8)

MismatchedDelimiters(Box<SourceLocation>, String)

InvalidAdmonitionVariant(Box<SourceLocation>, String)

InvalidConditionalDirective(Box<SourceLocation>)

InvalidIncludeDirective(Box<SourceLocation>, String)

InvalidIndent(Box<SourceLocation>, String)

IncludeIndentTooLarge(Box<SourceLocation>, usize, usize)

InvalidLevelOffset(Box<SourceLocation>, String)

InvalidDocumentAttribute

A document attribute value did not match its documented domain.

Fields

name: String

Document attribute name.

value: String

Value as supplied by the caller or document.

expected: &'static str

Short description of the accepted value domain.

location: Option<Box<SourceLocation>>

Source location for a document entry, when available.

Io(Error)

IncludeSource(IncludeSourceError)

IncludeSourceTooLarge(String)

IncludeExpansionTooLarge(Box<SourceLocation>, usize)

Selected text from repeated or nested includes exceeded the per-parse budget. Carries the directive’s location and the configured limit in bytes.

IncludeSelectionTooComplex(String)

Url(ParseError)

ParseInt(ParseIntError)

InvalidIfEvalDirectiveMismatchedTypes(Box<SourceLocation>)

UnknownEncoding(String)

UnrecognizedEncodingInFile(String)

NetworkDisabled

TryFromIntError(TryFromIntError)

NonConformingManpageTitle(Box<SourceLocation>, String)

Implementations

impl Error

pub fn source_location(&self) -> Option<&SourceLocation>

Extract source location information from this error if available. Returns the SourceLocation (either Location or Position) for errors that have positional information.

pub fn advice(&self) -> Option<&'static str>

Get advice for this error if available. Returns helpful information for resolving the error.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<IncludeSourceError> for Error

fn from(source: IncludeSourceError) -> Self

Converts to this type from the input type.

impl From<ParseError<LineCol>> for Error

fn from(source: ParseError<LineCol>) -> Self

Converts to this type from the input type.

impl From<ParseError> for Error

fn from(source: ParseError) -> Self

Converts to this type from the input type.

impl From<ParseIntError> for Error

fn from(source: ParseIntError) -> Self

Converts to this type from the input type.

impl From<TryFromIntError> for Error

fn from(source: TryFromIntError) -> Self

Converts to this type from the input type.