Enum WriteError

pub enum WriteError {
    InvalidHeadingLevel(u8),
    NewlineInInlineElement(String),
    FmtError(String),
    UnsupportedNodeType,
    InvalidStructure(String),
    InvalidHtmlTag(String),
    InvalidHtmlAttribute(String),
    Custom {
        message: String,
        code: Option<String>,
    },
}

Errors that can occur during CommonMark writing.

Variants

InvalidHeadingLevel(u8)

An invalid heading level was encountered (must be 1-6).

NewlineInInlineElement(String)

A newline character was found in an inline element where it’s not allowed (e.g., in strict mode or specific contexts like table cells, link text, image alt text).

FmtError(String)

An underlying formatting error occurred.

UnsupportedNodeType

An unsupported node type was encountered.

InvalidStructure(String)

Invalid structure in a node (e.g., mismatched table columns)

InvalidHtmlTag(String)

An invalid HTML tag was found (contains unsafe characters)

InvalidHtmlAttribute(String)

An invalid HTML attribute was found (contains unsafe characters)

Custom

A custom error with a message and optional error code.

Fields

message: String

Custom error message

code: Option<String>

Optional error code for programmatic identification

Implementations

impl WriteError

Convenience methods for creating custom errors

pub fn custom<S: Into<String>>(message: S) -> Self

Create a new custom error with a message

pub fn custom_with_code<S1: Into<String>, S2: Into<String>>( message: S1, code: S2, ) -> Self

Create a new custom error with a message and error code

Trait Implementations

impl Clone for WriteError

fn clone(&self) -> WriteError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WriteError

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

Formats the value using the given formatter.

impl Display for WriteError

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

Formats the value using the given formatter.

impl Error for WriteError

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 WriteError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl PartialEq for WriteError

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for WriteError

impl StructuralPartialEq for WriteError