pubmed-client 0.1.0

An async Rust client for PubMed and PMC APIs for retrieving biomedical research articles
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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189

use serde::{Deserialize, Serialize};

#[derive(Debug, Serialize, Deserialize)]
pub(crate) struct ESearchResult {
    pub esearchresult: ESearchData,
}

#[derive(Debug, Serialize, Deserialize)]
pub(crate) struct ESearchData {
    #[serde(default, rename = "ERROR")]
    pub error: Option<String>,
    #[serde(default)]
    pub count: Option<String>,
    #[serde(default)]
    pub retmax: Option<String>,
    #[serde(default)]
    pub retstart: Option<String>,
    #[serde(default)]
    pub idlist: Vec<String>,
    /// WebEnv session identifier for history server
    #[serde(default)]
    pub webenv: Option<String>,
    /// Query key for history server
    #[serde(default, rename = "querykey")]
    pub query_key: Option<String>,
    /// How PubMed interpreted and translated the search query
    #[serde(default)]
    pub querytranslation: Option<String>,
}

// EInfo API response structures
#[derive(Debug, Serialize, Deserialize)]
pub(crate) struct EInfoResponse {
    #[serde(rename = "einforesult")]
    pub einfo_result: EInfoResult,
}

#[derive(Debug, Serialize, Deserialize)]
pub(crate) struct EInfoResult {
    #[serde(rename = "dblist", default)]
    pub db_list: Option<Vec<String>>,
    #[serde(rename = "dbinfo", default)]
    pub db_info: Option<Vec<EInfoDbInfo>>,
}

#[derive(Debug, Serialize, Deserialize)]
pub(crate) struct EInfoDbInfo {
    #[serde(rename = "dbname")]
    pub db_name: String,
    #[serde(rename = "menuname")]
    pub menu_name: String,
    #[serde(rename = "description")]
    pub description: String,
    #[serde(rename = "dbbuild")]
    pub db_build: Option<String>,
    #[serde(rename = "count")]
    pub count: Option<String>,
    #[serde(rename = "lastupdate")]
    pub last_update: Option<String>,
    #[serde(rename = "fieldlist")]
    pub field_list: Option<Vec<EInfoField>>,
    #[serde(rename = "linklist")]
    pub link_list: Option<Vec<EInfoLink>>,
}

#[derive(Debug, Serialize, Deserialize)]
pub(crate) struct EInfoField {
    #[serde(rename = "name")]
    pub name: String,
    #[serde(rename = "fullname")]
    pub full_name: String,
    #[serde(rename = "description")]
    pub description: String,
    #[serde(rename = "termcount")]
    pub term_count: Option<String>,
    #[serde(rename = "isdate")]
    pub is_date: Option<String>,
    #[serde(rename = "isnumerical")]
    pub is_numerical: Option<String>,
    #[serde(rename = "singletoken")]
    pub single_token: Option<String>,
    #[serde(rename = "hierarchy")]
    pub hierarchy: Option<String>,
    #[serde(rename = "ishidden")]
    pub is_hidden: Option<String>,
}

#[derive(Debug, Serialize, Deserialize)]
pub(crate) struct EInfoLink {
    #[serde(rename = "name")]
    pub name: String,
    #[serde(rename = "menu")]
    pub menu: String,
    #[serde(rename = "description")]
    pub description: String,
    #[serde(rename = "dbto")]
    pub db_to: String,
}

// ESummary API response structures

/// ESummary returns a JSON object with "result" containing "uids" array and per-UID objects.
/// We use serde_json::Value to handle the dynamic per-UID keys, then parse manually.
#[derive(Debug, Serialize, Deserialize)]
pub(crate) struct ESummaryResponse {
    pub result: serde_json::Value,
}

#[derive(Debug, Serialize, Deserialize)]
pub(crate) struct ESummaryAuthor {
    pub name: String,
    #[serde(default)]
    pub authtype: String,
}

#[derive(Debug, Serialize, Deserialize)]
pub(crate) struct ESummaryArticleId {
    pub idtype: String,
    #[serde(default)]
    pub value: String,
}

#[derive(Debug, Serialize, Deserialize)]
pub(crate) struct ESummaryDocSum {
    pub uid: String,
    #[serde(default)]
    pub title: String,
    #[serde(default, rename = "sorttitle")]
    pub sort_title: String,
    #[serde(default)]
    pub source: String,
    #[serde(default)]
    pub authors: Vec<ESummaryAuthor>,
    #[serde(default)]
    pub pubdate: String,
    #[serde(default)]
    pub epubdate: String,
    #[serde(default)]
    pub volume: String,
    #[serde(default)]
    pub issue: String,
    #[serde(default)]
    pub pages: String,
    #[serde(default)]
    pub lang: Vec<String>,
    #[serde(default)]
    pub issn: String,
    #[serde(default)]
    pub essn: String,
    #[serde(default)]
    pub pubtype: Vec<String>,
    #[serde(default)]
    pub articleids: Vec<ESummaryArticleId>,
    #[serde(default)]
    pub fulljournalname: String,
    #[serde(default)]
    pub sortpubdate: String,
    #[serde(default)]
    pub pmcrefcount: u64,
    #[serde(default)]
    pub recordstatus: String,
}

// ELink API response structures
#[derive(Debug, Serialize, Deserialize)]
pub(crate) struct ELinkResponse {
    #[serde(rename = "linksets")]
    pub linksets: Vec<ELinkSet>,
}

#[derive(Debug, Serialize, Deserialize)]
pub(crate) struct ELinkSet {
    #[serde(rename = "dbfrom")]
    pub db_from: String,
    #[serde(rename = "ids")]
    pub ids: Vec<String>,
    #[serde(rename = "linksetdbs", default)]
    pub linkset_dbs: Option<Vec<ELinkSetDb>>,
}

#[derive(Debug, Serialize, Deserialize)]
pub(crate) struct ELinkSetDb {
    #[serde(rename = "dbto")]
    pub db_to: String,
    #[serde(rename = "linkname")]
    pub link_name: String,
    #[serde(rename = "links")]
    pub links: Vec<String>,
}