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

//! Defines the library's [`Result`] type and the [`Error`] enum.

/// A generic library result type.
pub type Result<T> = std::result::Result<T, Error>;

/// An enum representing all possible library errors.
#[derive(Debug, thiserror::Error)]
pub enum Error {
    /// Error returned when the default Apple Books database cannot be found.
    #[error("missing default Apple Books databases.")]
    MissingDefaultDatabase,

    /// Error returned when there are issues connecting to a database.
    #[error("unable to connect to '{name}*.sqlite' at {path}")]
    DatabaseConnection {
        /// The basename of the database: `BKLibrary` or `AEAnnotation`.
        name: String,
        /// The path to the database.
        path: String,
    },

    /// Error returned when querying a database fails.
    ///
    /// This most likely means that the database schema is different than
    /// the one the query has been designed for. In that case, the currently
    /// installed version of Apple Books is considered unsupported.
    #[error("unsupported Apple Books version: {version}")]
    UnsupportedVersion {
        /// The currently installed Apple Books version number.
        version: String,
    },

    /// Error returned when a syntax error is detected in how a template's
    /// config block is defined. This does not include YAML syntax error.
    #[error("cannot read config for: {path}.")]
    InvalidTemplateConfig {
        /// The partial path to the template e.g. `nested/template.md`.
        path: String,
    },

    /// Error returned if [`tera`][tera] encounters any errors.
    ///
    /// [tera]: https://docs.rs/tera/latest/tera/
    #[error(transparent)]
    InvalidTemplate(#[from] tera::Error),

    /// Error returned if [`serde_yaml`][serde-yaml] encounters any errors
    /// during deserialization.
    ///
    /// [serde-yaml]: https://docs.rs/serde_yaml/latest/serde_yaml/
    #[error(transparent)]
    DeserializationError(#[from] serde_yaml::Error),

    /// Error returned if any other IO errors are encountered.
    #[error(transparent)]
    IoError(#[from] std::io::Error),
}