Enum MarkdownParseError 

pub enum MarkdownParseError<E> {
    DocWriter(E),
    UnhandledEvent(&'static str),
    NestedMarkup {
        outer: &'static str,
        inner: &'static str,
    },
}

Available on crate feature parse-markdown only.

Error wraps errors during markdown processing by MarkdownParseExt::write_markdown and io errors occurring during writing.

Variants

DocWriter(E)

Error that occurred during writing to the DocumentationWriter.

UnhandledEvent(&'static str)

A piece of markdown was encountered that can not be translated to the API of a DocumentationWriter.

Examples

doc.start_description()?;
assert_eq!("markdown block quotes can not be written to a doc writer", &format!("{}", doc.write_markdown("> a").unwrap_err()));

NestedMarkup

A piece of marked-up text was found in a place where plain text was expected.

Examples

doc.start_description()?;
assert_eq!("markdown emphasized spans can not be nested in links", &format!("{}", doc.write_markdown("[*a*](b)").unwrap_err()));

Fields

outer: &'static str

The outer element ("links") in the example above.

inner: &'static str

The inner element ("emphasized spans") in the example above.

Trait Implementations

impl<E: Debug> Debug for MarkdownParseError<E>

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

Formats the value using the given formatter.

impl<E: Error> Display for MarkdownParseError<E>

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

Formats the value using the given formatter.

impl<E: Error> Error for MarkdownParseError<E>

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<E: Error> From<E> for MarkdownParseError<E>

fn from(e: E) -> Self

Converts to this type from the input type.