Enum MetadataError

pub enum MetadataError {
    ExtractionError {
        message: String,
    },
    ProcessingError {
        message: String,
    },
    MissingFieldError(String),
    DateParseError(String),
    IoError(Error),
    YamlError(Error),
    JsonError(Error),
    TomlError(Error),
    UnsupportedFormatError(String),
    ValidationError {
        field: String,
        message: String,
    },
    Utf8Error(Utf8Error),
    Other(Box<dyn Error + Send + Sync>),
}

Custom error types for the metadata-gen library.

This enum encompasses all possible errors that can occur during metadata extraction, processing, and related operations.

Variants

ExtractionError

Error occurred while extracting metadata.

Fields

message: String

A descriptive message about the extraction error.

ProcessingError

Error occurred while processing metadata.

Fields

message: String

A descriptive message about the processing error.

MissingFieldError(String)

Error occurred due to missing required field.

DateParseError(String)

Error occurred while parsing date.

IoError(Error)

I/O error.

YamlError(Error)

YAML parsing error.

JsonError(Error)

JSON parsing error.

TomlError(Error)

TOML parsing error.

UnsupportedFormatError(String)

Unsupported metadata format error.

ValidationError

Validation error for metadata fields.

Fields

field: String

The field that failed validation.

message: String

A descriptive message about the validation error.

Utf8Error(Utf8Error)

UTF-8 decoding error.

Other(Box<dyn Error + Send + Sync>)

Catch-all for unexpected errors.

Implementations

impl MetadataError

pub fn new_extraction_error(message: impl Into<String>) -> Self

Creates a new ExtractionError with the given message.

Arguments

• message - A descriptive message about the extraction error.

Returns

A new MetadataError::ExtractionError variant.

Example

use metadata_gen::error::MetadataError;

let error = MetadataError::new_extraction_error("Failed to extract title");
assert!(matches!(error, MetadataError::ExtractionError { .. }));

pub fn new_processing_error(message: impl Into<String>) -> Self

Creates a new ProcessingError with the given message.

Arguments

• message - A descriptive message about the processing error.

Returns

A new MetadataError::ProcessingError variant.

Example

use metadata_gen::error::MetadataError;

let error = MetadataError::new_processing_error("Failed to process metadata");
assert!(matches!(error, MetadataError::ProcessingError { .. }));

pub fn new_validation_error( field: impl Into<String>, message: impl Into<String>, ) -> Self

Creates a new ValidationError with the given field and message.

Arguments

• field - The name of the field that failed validation.
• message - A descriptive message about the validation error.

Returns

A new MetadataError::ValidationError variant.

Example

use metadata_gen::error::MetadataError;

let error = MetadataError::new_validation_error("title", "Title must not be empty");
assert!(matches!(error, MetadataError::ValidationError { .. }));

pub fn context<C>(self, ctx: C) -> Self

where C: Display + Send + Sync + 'static,

Adds context to an existing error.

This method wraps the current error with additional context information.

Arguments

• ctx - The context to add to the error.

Returns

A new MetadataError with the added context.

Example

use metadata_gen::error::MetadataError;

let error = MetadataError::new_extraction_error("Failed to parse YAML")
    .context("Processing file 'example.md'");
assert_eq!(error.to_string(), "Failed to extract metadata: Processing file 'example.md': Failed to parse YAML");

Trait Implementations

impl Debug for MetadataError

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

Formats the value using the given formatter.

impl Display for MetadataError

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

Formats the value using the given formatter.

impl Error for MetadataError

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<Box<dyn Error + Send + Sync>> for MetadataError

fn from(source: Box<dyn Error + Send + Sync>) -> Self

Converts to this type from the input type.

impl From<Error> for MetadataError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for MetadataError

fn from(source: SerdeYmlError) -> Self

Converts to this type from the input type.

impl From<Error> for MetadataError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for MetadataError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Utf8Error> for MetadataError

fn from(source: Utf8Error) -> Self

Converts to this type from the input type.