ebook-rs 0.7.1

Pure Rust multi-format eBook engine (EPUB2/3, MOBI, AZW3, FB2, LIT, CBZ, PDF) with CFI, Regex search, EPUB Validator, Readium LCP/Locator, Book Fingerprinting, and Citation Export APIs.
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

use serde::{Deserialize, Serialize};
use std::collections::HashMap;

/// Page progression direction (LTR, RTL, Default).
#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum PageProgressionDirection {
    #[default]
    Ltr,
    Rtl,
    Default,
}

/// Metadata extracted from the EPUB package document (.opf).
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct Metadata {
    pub title: String,
    pub creators: Vec<String>,
    pub publishers: Vec<String>,
    pub languages: Vec<String>,
    pub rights: Option<String>,
    pub description: Option<String>,
    pub identifier: Option<String>,
    pub pub_date: Option<String>,
    pub modified_date: Option<String>,
    pub subjects: Vec<String>,
    pub cover_id: Option<String>,
    pub cover_href: Option<String>,
    pub direction: PageProgressionDirection,
    pub meta_properties: HashMap<String, String>,
    pub accessibility: AccessibilityMetadata,
}

impl Metadata {
    /// Return first creator (author) or empty string.
    pub fn creator(&self) -> &str {
        self.creators.first().map(|s| s.as_str()).unwrap_or("")
    }

    /// Return first publisher if present.
    pub fn publisher(&self) -> Option<&str> {
        self.publishers.first().map(|s| s.as_str())
    }

    /// Return first language or empty string.
    pub fn language(&self) -> &str {
        self.languages.first().map(|s| s.as_str()).unwrap_or("")
    }
}

/// EPUB 3 Accessibility (a11y) Metadata conforming to W3C EPUB Accessibility 1.1 & Schema.org.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct AccessibilityMetadata {
    pub access_modes: Vec<String>,
    pub access_modes_sufficient: Vec<Vec<String>>,
    pub accessibility_features: Vec<String>,
    pub accessibility_hazards: Vec<String>,
    pub accessibility_summary: Option<String>,
    pub certified_by: Option<String>,
    pub certifier_credential: Option<String>,
    pub certifier_report: Option<String>,
    pub is_accessible: bool,
}

impl AccessibilityMetadata {
    /// Returns true if the EPUB specifies alternative text for visual assets.
    pub fn has_alternative_text(&self) -> bool {
        self.accessibility_features
            .iter()
            .any(|f| f.contains("alternativeText"))
    }

    /// Returns true if structural navigation (TOC/headings) is present.
    pub fn has_structural_navigation(&self) -> bool {
        self.accessibility_features
            .iter()
            .any(|f| f.contains("structuralNavigation") || f.contains("tableOfContents"))
    }

    /// Returns true if the book is screen-reader friendly (has text + structural nav).
    pub fn is_screen_reader_friendly(&self) -> bool {
        self.access_modes.iter().any(|m| m == "textual") && self.has_structural_navigation()
    }
}

/// A manifest item representing a resource inside the EPUB.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ManifestItem {
    pub id: String,
    pub href: String,
    pub full_path: String,
    pub media_type: String,
    pub properties: Vec<String>,
    pub fallback: Option<String>,
    pub media_overlay: Option<String>,
}

/// A spine item representing a reader page section in order.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SpineItem {
    pub idref: String,
    pub linear: bool,
    pub properties: Vec<String>,
    pub index: usize,
    pub href: String,
    pub media_type: String,
}

/// Guide or Landmark reference entry.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct GuideItem {
    pub type_: String,
    pub title: String,
    pub href: String,
    pub full_path: String,
}