Enum EpubError 

pub enum EpubError {
    ArchiveError {
        source: ZipError,
    },
    EmptyDataError,
    EpubBuilderError {
        source: EpubBuilderError,
    },
    FailedParsingXml,
    IOError {
        source: Error,
    },
    MissingRequiredAttribute {
        tag: String,
        attribute: String,
    },
    MutexError,
    NonCanonicalEpub {
        expected_file: String,
    },
    NonCanonicalFile {
        tag: String,
    },
    NoSupportedFileFormat,
    RealtiveLinkLeakage {
        path: String,
    },
    ResourceIdNotExist {
        id: String,
    },
    ResourceNotFound {
        resource: String,
    },
    UnrecognizedEpubVersion,
    UnsupportedEncryptedMethod {
        method: String,
    },
    UnusableCompressionMethod {
        file: String,
        method: String,
    },
    Utf8DecodeError {
        source: FromUtf8Error,
    },
    Utf16DecodeError {
        source: FromUtf16Error,
    },
    WalkDirError {
        source: Error,
    },
    QuickXmlError {
        source: Error,
    },
}

Types of errors that can occur during EPUB processing

This enumeration defines the various error cases that can be encountered when parsing and processing EPUB files, including file format errors, missing resources, compression issues, etc.

Variants

ArchiveError

ZIP archive related errors

Errors occur when processing the ZIP structure of EPUB files, such as file corruption, unreadability, etc.

Fields

source: ZipError

EmptyDataError

Data Decoding Error - Null dataw

This error occurs when trying to decode an empty stream.

EpubBuilderError

Fields

source: EpubBuilderError

FailedParsingXml

XML parsing failure error

This error usually only occurs when there is an exception in the XML parsing process, the event listener ends abnormally, resulting in the root node not being initialized. This exception may be caused by an incorrect XML file.

IOError

Fields

source: Error

MissingRequiredAttribute

Missing required attribute error

Triggered when an XML element in an EPUB file lacks the required attributes required by the EPUB specification.

Fields

tag: String

attribute: String

MutexError

Mutex error

This error occurs when a mutex is poisoned, which means that a thread has panicked while holding a lock on the mutex.

NonCanonicalEpub

Non-canonical EPUB structure error

This error occurs when an EPUB file lacks some files or directory structure that is required in EPUB specification.

Fields

expected_file: String

NonCanonicalFile

Non-canonical file structure error

This error is triggered when the required XML elements in the specification are missing from the EPUB file.

Fields

tag: String

NoSupportedFileFormat

Missing supported file format error

This error occurs when trying to get a resource but there isn’t any supported file format. It usually happens when there are no supported formats available in the fallback chain.

RealtiveLinkLeakage

Relative link leak error

This error occurs when a relative path link is outside the scope of an EPUB container, which is a security protection mechanism.

Fields

path: String

ResourceIdNotExist

Unable to find the resource id error

This error occurs when trying to get a resource by id but that id doesn’t exist in the manifest.

Fields

id: String

ResourceNotFound

Unable to find the resource error

This error occurs when an attempt is made to get a resource but it does not exist in the EPUB container.

Fields

resource: String

UnrecognizedEpubVersion

Unrecognized EPUB version error

This error occurs when parsing epub files, the library cannot directly or indirectly identify the epub version number.

UnsupportedEncryptedMethod

Unsupported encryption method error

This error is triggered when attempting to decrypt a resource that uses an encryption method not supported by this library.

Currently, this library only supports:

• IDPF Font Obfuscation
• Adobe Font Obfuscation

Fields

method: String

UnusableCompressionMethod

Unusable compression method error

This error occurs when an EPUB file uses an unsupported compression method.

Fields

file: String

method: String

Utf8DecodeError

UTF-8 decoding error

This error occurs when attempting to decode byte data into a UTF-8 string but the data is not formatted correctly.

Fields

source: FromUtf8Error

Utf16DecodeError

UTF-16 decoding error

This error occurs when attempting to decode byte data into a UTF-16 string but the data is not formatted correctly.

Fields

source: FromUtf16Error

WalkDirError

WalkDir error

This error occurs when using the WalkDir library to traverse the directory.

Fields

source: Error

QuickXmlError

QuickXml error

This error occurs when parsing XML data using the QuickXml library.

Fields

source: Error

Trait Implementations

impl Debug for EpubError

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

Formats the value using the given formatter.

impl Display for EpubError

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

Formats the value using the given formatter.

impl Error for EpubError

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<EpubBuilderError> for EpubError

Available on crate feature builder only.

fn from(value: EpubBuilderError) -> Self

Converts to this type from the input type.

impl From<Error> for EpubError

fn from(value: Error) -> Self

Converts to this type from the input type.

impl From<Error> for EpubError

fn from(value: Error) -> Self

Converts to this type from the input type.

impl From<Error> for EpubError

Available on crate feature builder only.

fn from(value: Error) -> Self

Converts to this type from the input type.

impl From<FromUtf16Error> for EpubError

fn from(value: FromUtf16Error) -> Self

Converts to this type from the input type.

impl From<FromUtf8Error> for EpubError

fn from(value: FromUtf8Error) -> Self

Converts to this type from the input type.

impl<T> From<PoisonError<T>> for EpubError

fn from(_value: PoisonError<T>) -> Self

Converts to this type from the input type.

impl From<ZipError> for EpubError

fn from(value: ZipError) -> Self

Converts to this type from the input type.