rbook 0.2.0

An ebook library that supports parsing and reading the epub format.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104

# rbook


[![Crates.io](https://img.shields.io/crates/v/rbook.svg?style=flat-square)](https://crates.io/crates/rbook)
[![Documentation](https://img.shields.io/badge/documentation-latest%20release-19e.svg?style=flat-square)](https://docs.rs/rbook)

An ebook library that supports parsing and reading the epub format.

## Usage

Including default features:
```toml
[dependencies]
rbook = "0.2.0"
```
Excluding default features:
```toml
[dependencies]
rbook = { version = "0.2.0", default-features = false }
```
Default features are the following:
- `reader`: Enables reading of the ebook file by file
- `statistics`: Enables word/character counting
## Examples
Other examples can be found in the ['tests'](tests) directory.

Opening and reading an epub file:
```rust
use rbook::Ebook;

fn main() {
    // Creating an epub instance
    let epub = rbook::Epub::new("example.epub").unwrap();

    // Retrieving the title
    println!("Title = {}", epub.metadata().title().unwrap().value());

    // Creating a reader instance
    let mut reader = epub.reader();

    // Printing the contents of each page
    while let Some(content) = reader.next_page() {
        let media_type = content.get(ContentType::Type).unwrap();
        assert_eq!("application/xhtml+xml", media_type);
        println!("{}", content);
    }
}
```

Accessing metadata elements and attributes:
```rust
use rbook::Ebook;

fn main() {
    let epub = rbook::Epub::new("example.epub").unwrap();

    // Retrieving the first creator metadata element
    let creator = epub.metadata().creators().unwrap().first().unwrap();
    assert_eq!("John Doe", creator.value());

    // Retrieving an attribute
    let id = creator.get_attribute("id").unwrap();
    assert_eq!("creator01", id);

    // Retrieving a child element
    let role = creator.get_child("role").unwrap();
    assert_eq!("aut", role.value());

    let scheme = role.get_attribute("scheme").unwrap();
    assert_eq!("marc:relators", scheme);
}
```

Extracting images:
```rust
use rbook::Ebook;

fn main() {
    let epub = rbook::Epub::new("example.epub").unwrap();

    let img_elements = epub.manifest().images().unwrap();

    // Create new directory to store extracted images
    let dir = Path::new("extracted_images");
    fs::create_dir(&dir).unwrap();

    for img_element in img_elements {
        let img_href = img_element.value();

        // Retrieve image contents
        let img = epub.read_bytes_file(img_href).unwrap();

        // Retrieve file name from image href
        let file_name = Path::new(img_href).file_name().unwrap();

        // Create new file
        let mut file = File::create(dir.join(file_name)).unwrap();
        file.write_all(&img).unwrap();
    }
}
```

## Sample ebooks

Sample ebooks in the ['tests/ebooks'](tests/ebooks) directory are provided as is from 
[IDPF](https://idpf.github.io/epub3-samples/30/samples.html) under the 
[CC-BY-SA 3.0](http://creativecommons.org/licenses/by-sa/3.0/) license.