mindat-rs 0.2.0

A Rust client library for the Mindat API - access mineralogical data including geomaterials, localities, and IMA minerals
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

//! Error types for the Mindat API client.

use thiserror::Error;

/// Errors that can occur when using the Mindat API client.
#[derive(Error, Debug)]
pub enum MindatError {
    /// HTTP request failed
    #[error("HTTP request failed: {0}")]
    Request(#[from] reqwest::Error),

    /// Failed to parse URL
    #[error("Invalid URL: {0}")]
    Url(#[from] url::ParseError),

    /// API returned an error response
    #[error("API error (status {status}): {message}")]
    Api { status: u16, message: String },

    /// Failed to deserialize response
    #[error("Failed to parse response: {0}")]
    Deserialization(#[from] serde_json::Error),

    /// Authentication error - missing or invalid token
    #[error("Authentication required: please provide a valid API token")]
    AuthenticationRequired,

    /// Rate limit exceeded
    #[error("Rate limit exceeded, please wait before making more requests")]
    RateLimited,

    /// Resource not found
    #[error("Resource not found: {0}")]
    NotFound(String),

    /// Invalid parameter value
    #[error("Invalid parameter: {0}")]
    InvalidParameter(String),
}

/// Result type alias for Mindat operations.
pub type Result<T> = std::result::Result<T, MindatError>;