Struct lib::models::data::Data

pub struct Data(_);

Defines a thin wrapper around the [Entries] type alias.

Allows default HashMap interaction via Deref and DerefMut, but also provides a few specific convenience methods.

The basic structure is as follows:

Data
 │
 └─ Entries
     │
     ├─ ID: Entry
     │       ├─ Book
     │       └─ Annotation
     ├─ ID: Entry
     │       ├─ Book
     │       └─ Annotation
     └─ ...

Implementations

impl Data

pub fn init(&mut self, path: &Path) -> Result<()>

Builds Entrys from the Apple Books databases.

Errors

See ABDatabase::query() for information on errors as these are the only sources of possible errors.

pub fn entries(&self) -> impl Iterator<Item = &Entry>

Returns an iterator over all Entrys.

pub fn entries_mut(&mut self) -> impl Iterator<Item = &mut Entry>

Returns a mutable iterator over all Entrys.

pub fn count_books(&self) -> usize

Returns the number of books.

Examples found in repository

src/lib/models/data.rs (line 101)

    pub fn init(&mut self, path: &Path) -> Result<()> {
        let books = ABDatabase::query::<Book>(path)?;
        let annotations = ABDatabase::query::<Annotation>(path)?;

        log::debug!(
            "found {} book(s) in {}.",
            books.len(),
            ABDatabaseName::Books.to_string()
        );

        log::debug!(
            "found {} annotation(s) in {}.",
            annotations.len(),
            ABDatabaseName::Annotations.to_string()
        );

        // `Entry`s are created from `Book`s. Note that `book.metadata.id` is
        // set as the key for each entry into the `Data`. This is later used to
        // compare with each `Annotation` to determine if the `Annotation`
        // belongs to a `Book` and therefore its `Entry`.
        //
        // See https://stackoverflow.com/q/69274529/16968574
        let mut data: Entries = books
            .into_iter()
            .map(|book| (book.metadata.id.clone(), Entry::from(book)))
            .collect();

        // `Annotation`s are pushed onto an `Entry` based on their `book_id`.
        for annotation in annotations {
            if let Some(entry) = data.get_mut(&annotation.metadata.book_id) {
                entry.annotations.push(annotation);
            }
        }

        // Remove `Entry`s that have no `Annotation`s.
        data.retain(|_, entry| !entry.annotations.is_empty());

        self.0 = data;

        log::debug!("created {} Book's", self.count_books());
        log::debug!("created {} Annotation's", self.count_annotations());

        Ok(())
    }

pub fn count_annotations(&self) -> usize

Returns the number of annotations.

Examples found in repository

src/lib/models/data.rs (line 102)

    pub fn init(&mut self, path: &Path) -> Result<()> {
        let books = ABDatabase::query::<Book>(path)?;
        let annotations = ABDatabase::query::<Annotation>(path)?;

        log::debug!(
            "found {} book(s) in {}.",
            books.len(),
            ABDatabaseName::Books.to_string()
        );

        log::debug!(
            "found {} annotation(s) in {}.",
            annotations.len(),
            ABDatabaseName::Annotations.to_string()
        );

        // `Entry`s are created from `Book`s. Note that `book.metadata.id` is
        // set as the key for each entry into the `Data`. This is later used to
        // compare with each `Annotation` to determine if the `Annotation`
        // belongs to a `Book` and therefore its `Entry`.
        //
        // See https://stackoverflow.com/q/69274529/16968574
        let mut data: Entries = books
            .into_iter()
            .map(|book| (book.metadata.id.clone(), Entry::from(book)))
            .collect();

        // `Annotation`s are pushed onto an `Entry` based on their `book_id`.
        for annotation in annotations {
            if let Some(entry) = data.get_mut(&annotation.metadata.book_id) {
                entry.annotations.push(annotation);
            }
        }

        // Remove `Entry`s that have no `Annotation`s.
        data.retain(|_, entry| !entry.annotations.is_empty());

        self.0 = data;

        log::debug!("created {} Book's", self.count_books());
        log::debug!("created {} Annotation's", self.count_annotations());

        Ok(())
    }

Trait Implementations

impl Debug for Data

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Data

fn default() -> Data

Returns the “default value” for a type.