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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67

//! Mineral relation types for the Mindat API (`/relations/`).

use serde::{Deserialize, Serialize};

use super::serde_helpers::{deserialize_i64, deserialize_optional_i64};

/// A relation between two minerals (`/relations/`).
///
/// Not to be confused with [`crate::Relation`], which is the embedded relation
/// object returned inside a geomaterial record.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct MineralRelation {
    /// Relation ID.
    #[serde(deserialize_with = "deserialize_i64")]
    pub rid: i64,
    /// First mineral (geomaterial) ID.
    #[serde(default, deserialize_with = "deserialize_optional_i64")]
    pub min1: Option<i64>,
    /// Second mineral (geomaterial) ID.
    #[serde(default, deserialize_with = "deserialize_optional_i64")]
    pub min2: Option<i64>,
    /// Relation type.
    #[serde(default)]
    pub rel: Option<serde_json::Value>,
}

/// Builder for `/relations/` query parameters.
#[derive(Debug, Clone, Default)]
pub struct RelationsQuery {
    /// Free-text search.
    pub q: Option<String>,
    /// Filter by first mineral ID.
    pub min1: Option<i64>,
    /// Filter by second mineral ID.
    pub min2: Option<i64>,
    /// Filter by relation type.
    pub rel: Option<i32>,
    /// Page number.
    pub page: Option<i32>,
    /// Page size.
    pub page_size: Option<i32>,
}

impl RelationsQuery {
    /// Create a new empty query.
    pub fn new() -> Self {
        Self::default()
    }

    /// Filter to relations involving a given mineral (as `min1`).
    pub fn mineral(mut self, mineral_id: i64) -> Self {
        self.min1 = Some(mineral_id);
        self
    }

    /// Set page number.
    pub fn page(mut self, page: i32) -> Self {
        self.page = Some(page);
        self
    }

    /// Set page size.
    pub fn page_size(mut self, size: i32) -> Self {
        self.page_size = Some(size);
        self
    }
}