Expand description
Epub library
A Rust library for reading and manipulating EPUB eBook files.
This library provides complete EPUB file parsing functionality, supporting EPUB 2 and EPUB 3 formats. It can extract metadata, access content files, and handle encrypted resources. Furthermore, this library also provides a convenient way to build epub files from a set of resources.
§Features
- Parse EPUB file structure and containers, extract metadata, access resource files.
- Automatic handle encrypted content.
- Optional EPUB build functionality via ‘builder’ feature.
- EPUB specification-compliant verification mechanism.
§Quick Start
§Read EPUB Files
ⓘ
// Open EPUB file
let doc = EpubDoc::new("path/to/epub/file.epub")?;
// Get metadata
println!("Title: {:?}", doc.get_title()?);
println!("Creator: {:?}", doc.get_metadata_value("creator")?);
// Read content
let (_content, _mime) = doc.spine_current()?;
let (_content, _mime) = doc.next_spine()?;
§Enable Builder Feature
Enable the builder feature in Cargo.toml:
[dependencies]
lib-epub = { version = "0.0.5", features = ["builder"] }§Module Description
- epub - Core functionality for EPUB document parsing
- error - Error type definition
- types - Data structure definition
- builder - EPUB build functionality (requires enabling the
builderfeature)
§Exported Trait
- DecodeBytes - Byte data decoding trait, used to convert raw bytes into strings
Modules§
- builder
- Epub Builder
- epub
- The core module of the EPUB parsing library
- error
- Error Type Definition Module
- types
- Types and data structures for EPUB processing
Traits§
- Decode
Bytes - Provides functionality to decode byte data into strings