Enum SitemapError 

#[non_exhaustive]
pub enum SitemapError {
    XmlWriteError(Error),
    XmlParseError(Error),
    DateError(DateTimeError),
    UrlError(ParseError),
    IoError(Error),
    EncodingError(FromUtf8Error),
    InvalidChangeFreq(String),
    CustomError(String),
    SitemapTooLarge,
    MaxUrlLimitExceeded(usize),
}

Errors that can occur when working with sitemaps.

This enum represents all possible errors that can occur within the sitemap library. It uses the thiserror crate for deriving the Error trait, which simplifies error handling and provides good interoperability with the standard library.

The non_exhaustive attribute allows for future expansion of the error types without breaking backwards compatibility.

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.

XmlWriteError(Error)

Error occurred during XML writing.

XmlParseError(Error)

Error occurred during XML parsing.

DateError(DateTimeError)

Error occurred during date parsing or formatting.

UrlError(ParseError)

Error occurred during URL parsing.

IoError(Error)

Error occurred during I/O operations.

EncodingError(FromUtf8Error)

Error occurred during string encoding.

InvalidChangeFreq(String)

Invalid change frequency provided.

CustomError(String)

Custom error for unforeseen scenarios.

SitemapTooLarge

Error occurred when a sitemap exceeds the maximum allowed size.

MaxUrlLimitExceeded(usize)

Error occurred when the number of URLs in a sitemap exceeds the maximum allowed.

Implementations

impl SitemapError

pub fn context(&self) -> &'static str

Provides additional context for the error.

This method returns a static string that gives more information about the context in which the error occurred. This can be useful for logging or providing more detailed error messages to users.

Returns

A string slice describing the context of the error.

Trait Implementations

impl Debug for SitemapError

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

Formats the value using the given formatter.

impl Display for SitemapError

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

Formats the value using the given formatter.

impl Error for SitemapError

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<DateTimeError> for SitemapError

fn from(source: DateTimeError) -> Self

Converts to this type from the input type.

impl From<EmitterError> for SitemapError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for SitemapError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for SitemapError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<FromUtf8Error> for SitemapError

fn from(source: FromUtf8Error) -> Self

Converts to this type from the input type.

impl From<ParseError> for SitemapError

fn from(source: ParseError) -> Self

Converts to this type from the input type.