papers-zotero 0.3.1

Rust client for the Zotero personal research library API
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

/// Errors returned by [`ZoteroClient`](crate::ZoteroClient) methods.
///
/// # Variants
///
/// - [`Http`](ZoteroError::Http) — network or connection failure (wraps
///   [`reqwest::Error`])
/// - [`Json`](ZoteroError::Json) — response body could not be deserialized
///   (wraps [`serde_json::Error`])
/// - [`Api`](ZoteroError::Api) — the Zotero API returned a non-success HTTP
///   status code (e.g. 404 for unknown item, 403 for forbidden, 500 for server
///   error)
#[derive(Debug, thiserror::Error)]
pub enum ZoteroError {
    /// Network or connection error from reqwest.
    #[error("HTTP error: {0}")]
    Http(#[from] reqwest::Error),

    /// Failed to deserialize the JSON response body.
    #[error("JSON error: {0}")]
    Json(#[from] serde_json::Error),

    /// The API returned a non-success HTTP status code.
    ///
    /// `status` is the HTTP status code (e.g. 404, 403, 500) and `message`
    /// contains the response body text.
    #[error("API error (status {status}): {message}")]
    Api { status: u16, message: String },

    /// Zotero is installed on this machine but its local API is not reachable.
    /// Set ZOTERO_CHECK_LAUNCHED=0 to disable this check.
    #[error(
        "Zotero is installed but not running (found at {path}).\n\
         Start Zotero and try again, or set ZOTERO_CHECK_LAUNCHED=0 to use the remote API instead."
    )]
    NotRunning { path: String },
}

/// A [`Result`](std::result::Result) alias with [`ZoteroError`] as the error
/// type.
pub type Result<T> = std::result::Result<T, ZoteroError>;