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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134

//! Crystallography types for the Mindat API: crystal classes, space groups,
//! and space-group sets.

use serde::{Deserialize, Serialize};

use super::serde_helpers::{deserialize_i32, deserialize_optional_i32};

/// A crystal class / point group (`/crystalclasses/`).
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CrystalClass {
    /// Crystal class ID.
    #[serde(deserialize_with = "deserialize_i32")]
    pub id: i32,
    /// Crystal system.
    #[serde(default)]
    pub system: Option<String>,
    /// Hermann–Mauguin symbol.
    #[serde(default)]
    pub symbol: Option<String>,
    /// Class name.
    #[serde(default)]
    pub name: Option<String>,
}

/// A space group (`/spacegroups/`).
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SpaceGroup {
    /// Space group ID.
    #[serde(deserialize_with = "deserialize_i32")]
    pub id: i32,
    /// Crystal class ID.
    #[serde(default, deserialize_with = "deserialize_optional_i32")]
    pub cclass: Option<i32>,
    /// Space group symbol/text.
    #[serde(default)]
    pub sgtext: Option<String>,
}

/// A space group setting (`/spacegroupsets/`).
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SpaceGroupSet {
    /// Space group set ID.
    #[serde(deserialize_with = "deserialize_i32")]
    pub id: i32,
    /// Space group ID.
    #[serde(default, deserialize_with = "deserialize_optional_i32")]
    pub spacegroup: Option<i32>,
    /// Crystal class ID.
    #[serde(default, deserialize_with = "deserialize_optional_i32")]
    pub cclass: Option<i32>,
    /// Space group set symbol/text.
    #[serde(default)]
    pub sgstext: Option<String>,
}

/// Builder for `/crystalclasses/` query parameters.
#[derive(Debug, Clone, Default)]
pub struct CrystalClassesQuery {
    /// Filter by crystal system.
    pub system: Option<String>,
    /// Filter by symbol.
    pub symbol: Option<String>,
    /// Filter by a set of IDs.
    pub id_in: Option<Vec<i32>>,
    /// Page number.
    pub page: Option<i32>,
    /// Page size.
    pub page_size: Option<i32>,
}

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

    /// Filter by crystal system.
    pub fn system(mut self, system: impl Into<String>) -> Self {
        self.system = Some(system.into());
        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
    }
}

/// Builder for `/spacegroups/` query parameters.
#[derive(Debug, Clone, Default)]
pub struct SpaceGroupsQuery {
    /// Filter by crystal class ID.
    pub cclass: Option<i32>,
    /// Filter by space group text.
    pub sgtext: Option<String>,
    /// Filter by a set of IDs.
    pub id_in: Option<Vec<i32>>,
    /// Page number.
    pub page: Option<i32>,
    /// Page size.
    pub page_size: Option<i32>,
}

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

    /// Filter by crystal class ID.
    pub fn crystal_class(mut self, cclass: i32) -> Self {
        self.cclass = Some(cclass);
        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
    }
}