Enum FrontmatterError

pub enum FrontmatterError {
    ContentTooLarge {
        size: usize,
        max: usize,
    },
    NestingTooDeep {
        depth: usize,
        max: usize,
    },
    YamlParseError {
        source: Error,
    },
    TomlParseError(Error),
    JsonParseError(Error),
    InvalidFormat,
    ConversionError(String),
    ParseError(String),
    UnsupportedFormat {
        line: usize,
    },
    NoFrontmatterFound,
    InvalidJson,
    InvalidToml,
    InvalidYaml,
    InvalidUrl(String),
    InvalidLanguage(String),
    JsonDepthLimitExceeded,
    ExtractionError(String),
    ValidationError(String),
}

Represents errors that can occur during frontmatter operations.

This enum uses the thiserror crate to provide structured error messages, improving the ease of debugging and handling errors encountered in frontmatter processing.

Variants

ContentTooLarge

Content exceeds the maximum allowed size

Fields

size: usize

The actual size of the content

max: usize

The maximum allowed size

NestingTooDeep

Nesting depth exceeds the maximum allowed

Fields

depth: usize

The actual nesting depth

max: usize

The maximum allowed depth

YamlParseError

Error occurred while parsing YAML content

Fields

source: Error

The original error from the YAML parser

TomlParseError(Error)

Error occurred while parsing TOML content

JsonParseError(Error)

Error occurred while parsing JSON content

InvalidFormat

The frontmatter format is invalid or unsupported

ConversionError(String)

Error occurred during conversion between formats

ParseError(String)

Generic error during parsing

UnsupportedFormat

Unsupported or unknown frontmatter format was detected

Fields

line: usize

The line number where the unsupported format was encountered

NoFrontmatterFound

No frontmatter content was found

InvalidJson

Invalid JSON frontmatter

InvalidToml

Invalid TOML frontmatter

InvalidYaml

Invalid YAML frontmatter

InvalidUrl(String)

Invalid URL format

InvalidLanguage(String)

Invalid language code

JsonDepthLimitExceeded

JSON frontmatter exceeds maximum nesting depth

ExtractionError(String)

Error during frontmatter extraction

ValidationError(String)

Input validation error

Implementations

impl FrontmatterError

pub fn generic_parse_error(message: &str) -> Self

Creates a generic parse error with a custom message.

Arguments

• message - A string slice containing the error message

Examples

use frontmatter_gen::error::FrontmatterError;

let error = FrontmatterError::generic_parse_error("Invalid syntax");
assert!(matches!(error, FrontmatterError::ParseError(_)));

pub fn unsupported_format(line: usize) -> Self

Creates an unsupported format error for a specific line.

Arguments

• line - The line number where the unsupported format was detected

Examples

use frontmatter_gen::error::FrontmatterError;

let error = FrontmatterError::unsupported_format(42);
assert!(matches!(error, FrontmatterError::UnsupportedFormat { line: 42 }));

pub fn validation_error(message: &str) -> Self

Creates a validation error with a custom message.

Arguments

• message - A string slice containing the validation error message

Examples

use frontmatter_gen::error::FrontmatterError;

let error = FrontmatterError::validation_error("Invalid character in title");
assert!(matches!(error, FrontmatterError::ValidationError(_)));

Trait Implementations

impl Clone for FrontmatterError

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FrontmatterError

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

Formats the value using the given formatter.

impl Display for FrontmatterError

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

Formats the value using the given formatter.

impl Error for FrontmatterError

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 FrontmatterError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for FrontmatterError

fn from(source: JsonError) -> Self

Converts to this type from the input type.