Enum EpubBuilderError 

pub enum EpubBuilderError {
    IllegalManifestPath {
        manifest_id: String,
    },
    ManifestCircularReference {
        fallback_chain: String,
    },
    ManifestNotFound {
        manifest_id: String,
    },
    MissingNecessaryMetadata,
    NavigationInfoUninitalized,
    MissingRootfile,
    TargetIsNotFile {
        target_path: String,
    },
    TooManyNavFlags,
    UnknowFileFormat {
        file_path: String,
    },
}

Types of errors that can occur during EPUB build

This enumeration defines various error conditions that may occur when creating EPUB files using the builder function. These errors are typically related to EPUB specification requirements or validation rules during the build process.

Variants

IllegalManifestPath

Illegal manifest path error

This error is triggered when the path corresponding to a resource ID in the manifest begins with “../”. Using relative paths starting with “../” when building the manifest fails to determine the ‘current location’, making it impossible to pinpoint the resource.

Fields

manifest_id: String

ManifestCircularReference

Manifest Circular Reference error

This error is triggered when a fallback relationship between manifest items forms a cycle.

Fields

fallback_chain: String

ManifestNotFound

Manifest resource not found error

This error is triggered when a manifest item specifies a fallback resource ID that does not exist.

Fields

manifest_id: String

MissingNecessaryMetadata

Missing necessary metadata error

This error is triggered when the basic metadata required to build a valid EPUB is missing. The following must be included: title, language, and an identifier with a ‘pub-id’ ID.

NavigationInfoUninitalized

Navigation information uninitialized error

This error is triggered when attempting to build an EPUB but without setting navigation information.

MissingRootfile

Missing rootfile error

This error is triggered when attempting to build an EPUB without adding any ‘rootfile’.

TargetIsNotFile

Target is not a file error

This error is triggered when the specified target path is not a file.

Fields

target_path: String

TooManyNavFlags

Too many nav flags error

This error is triggered when the manifest contains multiple items with the nav attribute. The EPUB specification requires that each EPUB have only one navigation document.

UnknowFileFormat

Unknown file format error

This error is triggered when the format type of the specified file cannot be analyzed.

Fields

file_path: String

Trait Implementations

impl Debug for EpubBuilderError

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

Formats the value using the given formatter.

impl Display for EpubBuilderError

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

Formats the value using the given formatter.

impl Error for EpubBuilderError

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.