readstor 0.6.0

A CLI for Apple Books annotations
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
137
138

//! Defines types for deserializing iOS's Apple Books plists data.

use serde::Deserialize;
use std::collections::HashMap;

/// A struct representing the data structure of the book plist file.
///
/// The structure is as follows:
///
/// ```plaintext
/// "Books"
///  │
///  ├── Book
///  ├── Book
///  └── ...
/// ```
///
/// And represented as JSON:
///
/// ```json
/// {
///   "Books": [
///     {
///       "Package Hash": "07B4BBF8CB409B439C0B5F14622C32F4",
///       ...
///     },
///     {
///       "Package Hash": "9E6143AA0FAC031691359779729F9B37",
///       ...
///     },
///     ...
///   ]
/// }
/// ```
#[derive(Debug, Deserialize)]
pub(super) struct BooksPlist {
    #[serde(alias = "Books")]
    pub books: Vec<BookRaw>,
}

/// A struct representing a book and its metadata in the books plist file.
#[derive(Debug, Deserialize)]
pub struct BookRaw {
    #[serde(alias = "Artist")]
    #[allow(missing_docs)]
    pub author: String,

    #[serde(alias = "Name")]
    #[allow(missing_docs)]
    pub title: String,

    #[serde(alias = "Package Hash")]
    #[allow(missing_docs)]
    pub id: String,
}

/// A type alias representing the data structure of the annotations plist file.
///
/// The structure is as follows:
///
/// ```plaintext
/// "Bookmark-Container-XXXXXXXX"
///  │
///  ├── "Bookmarks"
///  │   ├── Annotation
///  │   ├── Annotation
///  │   └── ...
///  └── "Generation"
/// ```
///
/// And represented as JSON:
///
/// ```json
/// {
///   "Bookmark-Container-XXXXXXXX": {
///     "Bookmarks": [
///       {
///         "annotationUuid": "2244252D-6496-4BC2-87D0-72D5B3D86600",
///         ...
///       },
///       {
///         "annotationUuid": "BFE9ABA9-2F0E-42A8-8320-E1A30A79C5A8",
///         ...
///       },
///       ...
///     ],
///     "Generation": XXXXXXXXXX
///   }
/// }
/// ```
pub(super) type AnnotationsPlist = HashMap<String, Bookmarks>;

/// A struct representing an inner structure of the annotations plist file.
#[derive(Debug, Deserialize)]
pub(super) struct Bookmarks {
    #[serde(alias = "Bookmarks")]
    pub bookmarks: Vec<AnnotationRaw>,
}

/// A struct representing an annotation and its metadata in the annotations plist file.
#[derive(Debug, Deserialize)]
pub struct AnnotationRaw {
    #[serde(alias = "annotationSelectedText")]
    #[allow(missing_docs)]
    pub body: String,

    #[serde(alias = "annotationStyle")]
    #[allow(missing_docs)]
    pub style: usize,

    #[serde(alias = "annotationNote")]
    #[allow(missing_docs)]
    pub notes: Option<String>,

    #[serde(alias = "annotationUuid")]
    #[allow(missing_docs)]
    pub id: String,

    #[serde(alias = "annotationAssetID")]
    #[allow(missing_docs)]
    pub book_id: String,

    #[serde(alias = "annotationCreationDate")]
    #[allow(missing_docs)]
    pub created: f64,

    #[serde(alias = "annotationModificationDate")]
    #[allow(missing_docs)]
    pub modified: f64,

    #[serde(alias = "annotationLocation")]
    #[allow(missing_docs)]
    pub epubcfi: String,

    #[serde(alias = "annotationDeleted")]
    #[allow(missing_docs)]
    pub is_deleted: usize,
}