rbook 0.7.4

A fast, format-agnostic, ergonomic ebook library for reading, building, and editing EPUB 2 and 3.
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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136

mod container;
mod package;
mod resource;
mod toc;

use crate::epub::Epub;
use crate::epub::metadata::EpubVersion;
use crate::epub::write::OrphanFilter;
use crate::epub::write::writer::toc::TocContext;
use crate::writer::WriterResult;
use crate::writer::zip::{ZipFileOptionsExt, ZipWriter};
use std::fmt::Debug;
use std::io::Write;
use std::sync::Arc;
use zip::write::SimpleFileOptions;

#[derive(Clone)]
pub(super) struct EpubWriteConfig {
    /// See [`super::EpubWriteOptions::target`]
    pub(super) targets: EpubWriteTargets,
    /// See [`super::EpubWriteOptions::generate_toc`]
    pub(super) generate_toc: bool,
    /// See [`super::EpubWriteOptions::toc_stylesheet`]
    pub(super) generated_toc_stylesheets: Option<Vec<String>>,
    /// See [`super::EpubWriteOptions::compression`]
    pub(super) compression: u8,
    /// See [`super::EpubWriteOptions::keep_orphans`]
    pub(super) keep_orphans: Option<Arc<dyn OrphanFilter>>,
}

impl Default for EpubWriteConfig {
    fn default() -> Self {
        Self {
            targets: EpubWriteTargets::new(EpubVersion::EPUB2),
            generate_toc: true,
            generated_toc_stylesheets: None,
            compression: 6,
            keep_orphans: None,
        }
    }
}

impl Debug for EpubWriteConfig {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("EpubWriteConfig")
            .field("targets", &self.targets)
            .field("generate_toc", &self.generate_toc)
            .field("compression", &self.compression)
            .finish_non_exhaustive()
    }
}

#[derive(Copy, Clone, Debug, Default)]
pub(super) struct EpubWriteTargets {
    epub2: bool,
    epub3: bool,
}

impl EpubWriteTargets {
    fn new(initial_target: EpubVersion) -> Self {
        let mut targets = Self::default();
        targets.add(initial_target);
        targets
    }

    pub(super) fn add(&mut self, target: EpubVersion) {
        match target.as_major() {
            EpubVersion::Epub3(_) => self.epub3 = true,
            EpubVersion::Epub2(_) => self.epub2 = true,
            _ => {}
        }
    }

    pub(super) fn clear(&mut self) {
        *self = Self::default();
    }
}

struct EpubWriterContext<'ebook> {
    epub: &'ebook Epub,
    config: &'ebook EpubWriteConfig,
    toc: TocContext<'ebook>,
}

impl EpubWriterContext<'_> {
    fn supports_epub3(&self) -> bool {
        self.version().is_epub3() || self.config.targets.epub3
    }

    fn supports_epub2(&self) -> bool {
        self.version().is_epub2() || self.config.targets.epub2
    }

    fn version(&self) -> EpubVersion {
        self.epub.package.version.parsed
    }
}

pub(super) struct EpubWriter<'ebook, W: Write> {
    ctx: EpubWriterContext<'ebook>,
    zip: ZipWriter<W>,
}

impl<'ebook, W: Write> EpubWriter<'ebook, W> {
    pub(super) fn new(config: &'ebook EpubWriteConfig, epub: &'ebook Epub, writer: W) -> Self {
        Self {
            ctx: EpubWriterContext {
                toc: TocContext::generate(config, epub),
                epub,
                config,
            },
            zip: ZipWriter::new(
                writer,
                SimpleFileOptions::default()
                    .zip_last_modified_date(epub.metadata().modified())
                    .zip_compression_level(config.compression),
            ),
        }
    }

    pub(super) fn write(mut self) -> WriterResult<W> {
        self.write_mimetype()?;
        self.write_container()?;
        self.write_package()?;
        self.write_toc()?;
        self.write_resources()?;
        self.zip.finish()
    }

    fn write_mimetype(&mut self) -> WriterResult<()> {
        // EPUB requires that the mimetype file must be uncompressed
        self.zip.start_uncompressed_file("mimetype")?;
        self.zip.write_all(b"application/epub+zip")?;
        Ok(())
    }
}