16 stable releases

2.1.1 Jun 26, 2023
2.0.0 Dec 29, 2022
1.2.4 Nov 2, 2022
1.2.3 Nov 19, 2020
0.1.2 Jan 20, 2017

#125 in Filesystem

Download history 79/week @ 2024-01-01 183/week @ 2024-01-08 425/week @ 2024-01-15 361/week @ 2024-01-22 339/week @ 2024-01-29 493/week @ 2024-02-05 182/week @ 2024-02-12 147/week @ 2024-02-19 212/week @ 2024-02-26 158/week @ 2024-03-04 237/week @ 2024-03-11 187/week @ 2024-03-18 203/week @ 2024-03-25 303/week @ 2024-04-01 154/week @ 2024-04-08 201/week @ 2024-04-15

876 downloads per month
Used in 10 crates

GPL-3.0 license

1MB
718 lines

epub-rs

Rust library to support the reading of epub files.

Install

Add this to your Cargo.toml:

[dependencies]
epub = "1.2.2"

MSRV

The minimum supported Rust version is 1.42.0.


lib.rs:

EPUB library lib to read and navigate through an epub file contents

Examples

Opening

use epub::doc::EpubDoc;
let doc = EpubDoc::new("test.epub");
assert!(doc.is_ok());
let doc = doc.unwrap();

Getting doc metatada

Metadata is a HashMap storing all metadata defined in the epub

let title = doc.mdata("title");
assert_eq!(title.unwrap(), "Todo es mío");

Accessing resources

In the resources var is stored each resource defined in the epub indexed by the id and with the full internal path and mimetype. It's a HashMap<a: String, (b: String, c: String)> where a is the resource id, b is the resource full path and c is the resource mimetype

assert_eq!(23, doc.resources.len());
let tpage = doc.resources.get("titlepage.xhtml");
assert_eq!(tpage.unwrap().0, Path::new("OEBPS/Text/titlepage.xhtml"));
assert_eq!(tpage.unwrap().1, "application/xhtml+xml");

Navigating using the spine

Spine is a Vec<String> storing the epub spine as resources ids

assert_eq!(17, doc.spine.len());
assert_eq!("titlepage.xhtml", doc.spine[0]);

Navigation using the doc internal state

use epub::doc::EpubDoc;
let doc = EpubDoc::new("test.epub");
let mut doc = doc.unwrap();
assert_eq!(0, doc.get_current_page());
assert_eq!("application/xhtml+xml", doc.get_current_mime().unwrap());

doc.go_next();
assert_eq!("000.xhtml", doc.get_current_id().unwrap());
doc.go_next();
assert_eq!("001.xhtml", doc.get_current_id().unwrap());
doc.go_prev();
assert_eq!("000.xhtml", doc.get_current_id().unwrap());

doc.set_current_page(2);
assert_eq!("001.xhtml", doc.get_current_id().unwrap());
assert_eq!(2, doc.get_current_page());
assert!(!doc.set_current_page(50));

// doc.get_current() will return a Vec<u8> with the current page content
// doc.get_current_str() will return a String with the current page content

Getting the cover

use std::fs;
use std::io::Write;
use epub::doc::EpubDoc;

let doc = EpubDoc::new("test.epub");
assert!(doc.is_ok());
let mut doc = doc.unwrap();

let cover_data = doc.get_cover().unwrap();

let f = fs::File::create("/tmp/cover.png");
assert!(f.is_ok());
let mut f = f.unwrap();
let resp = f.write_all(&cover_data);

Dependencies

~4–6MB
~105K SLoC