Enum MdError 

#[non_exhaustive]
pub enum MdError {
    InvalidFrontmatter {
        detail: String,
    },
    FrontmatterUnclosed,
    TemplateResolution {
        detail: String,
    },
    UnsupportedStructure {
        detail: String,
    },
    LosslessParse {
        detail: String,
    },
    LosslessMissingAttribute {
        element: &'static str,
        attribute: &'static str,
    },
    LosslessInvalidAttribute {
        element: &'static str,
        attribute: &'static str,
        value: String,
    },
    FileTooLarge {
        size: u64,
        limit: u64,
    },
    Io(Error),
    Core(CoreError),
    Blueprint(BlueprintError),
    Foundation(FoundationError),
}

Top-level error type for smithy-md operations.

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.

InvalidFrontmatter

YAML frontmatter exists but failed to parse.

Fields

detail: String

Parsing error details.

FrontmatterUnclosed

The document started a frontmatter block but never closed it.

TemplateResolution

Template inheritance could not be resolved with available providers.

Fields

detail: String

Resolution error details.

UnsupportedStructure

The markdown content contains a structure this decoder cannot map.

Fields

detail: String

Unsupported structure details.

LosslessParse

Lossless body parsing failed.

Fields

detail: String

Parsing error details.

LosslessMissingAttribute

Required attribute is missing in a lossless element.

Fields

element: &'static str

Element name.

attribute: &'static str

Missing attribute name.

LosslessInvalidAttribute

Attribute value in a lossless element is invalid.

Fields

element: &'static str

Element name.

attribute: &'static str

Attribute name.

value: String

Invalid value.

FileTooLarge

Input file exceeds the maximum allowed size.

Fields

size: u64

Actual file size in bytes.

limit: u64

Maximum allowed size in bytes.

Io(Error)

I/O error for file convenience APIs.

Core(CoreError)

Core-layer error propagated upward.

Blueprint(BlueprintError)

Blueprint-layer error propagated upward.

Foundation(FoundationError)

Foundation-layer error propagated upward.

Implementations

impl MdError

pub fn code(&self) -> MdErrorCode

Returns the corresponding stable error code.

Trait Implementations

impl Debug for MdError

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

Formats the value using the given formatter.

impl Display for MdError

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

Formats the value using the given formatter.

impl Error for MdError

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<BlueprintError> for MdError

fn from(source: BlueprintError) -> Self

Converts to this type from the input type.

impl From<CoreError> for MdError

fn from(source: CoreError) -> Self

Converts to this type from the input type.

impl From<Error> for MdError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<FoundationError> for MdError

fn from(source: FoundationError) -> Self

Converts to this type from the input type.