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

//! Defines the [`Entry`] struct.

use std::collections::HashMap;

use serde::Serialize;

use super::annotation::Annotation;
use super::book::Book;

/// A type alias represening how [`Entry`]s are organized.
///
/// [`Entries`] is a `HashMap` composed of `key:value` pairs of where the value is an [`Entry`] and
/// the key is the unique id of its [`Book`], taken from the [`BookMetadata::id`][book-metadata-id]
/// field.
///
/// For example:
///
/// ```plaintext
/// Entries
///  │
///  ├── ID: Entry
///  ├── ID: Entry
///  └── ...
/// ```
///
/// [book-metadata-id]: crate::models::book::BookMetadata::id
pub type Entries = HashMap<String, Entry>;

/// A container struct that stores a [`Book`] and its respective [`Annotation`]s.
#[derive(Debug, Default, Clone, Serialize)]
pub struct Entry {
    /// The entry's [`Book`].
    pub book: Book,

    /// The entry's [`Annotation`]s.
    pub annotations: Vec<Annotation>,
}

impl From<Book> for Entry {
    /// Constructs an instance of [`Entry`] via a [`Book`] object. This is the primary way
    /// [`Entry`]s are created.
    fn from(book: Book) -> Self {
        Self {
            book,
            annotations: Vec::new(),
        }
    }
}