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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
//! Advanced search methods for MeSH terms, authors, and specialized filtering

use super::SearchQuery;

impl SearchQuery {
    /// Filter by MeSH major topic
    ///
    /// # Arguments
    ///
    /// * `mesh_term` - MeSH term to filter by as a major topic
    ///
    /// # Example
    ///
    /// ```
    /// use pubmed_client_rs::pubmed::SearchQuery;
    ///
    /// let query = SearchQuery::new()
    ///     .mesh_major_topic("Diabetes Mellitus, Type 2");
    /// ```
    pub fn mesh_major_topic<S: Into<String>>(mut self, mesh_term: S) -> Self {
        self.filters.push(format!("{}[majr]", mesh_term.into()));
        self
    }

    /// Filter by MeSH term
    ///
    /// # Arguments
    ///
    /// * `mesh_term` - MeSH term to filter by
    ///
    /// # Example
    ///
    /// ```
    /// use pubmed_client_rs::pubmed::SearchQuery;
    ///
    /// let query = SearchQuery::new()
    ///     .mesh_term("Neoplasms");
    /// ```
    pub fn mesh_term<S: Into<String>>(mut self, mesh_term: S) -> Self {
        self.filters.push(format!("{}[mh]", mesh_term.into()));
        self
    }

    /// Filter by multiple MeSH terms
    ///
    /// # Arguments
    ///
    /// * `mesh_terms` - MeSH terms to filter by
    ///
    /// # Example
    ///
    /// ```
    /// use pubmed_client_rs::pubmed::SearchQuery;
    ///
    /// let query = SearchQuery::new()
    ///     .mesh_terms(&["Neoplasms", "Antineoplastic Agents"]);
    /// ```
    pub fn mesh_terms<S: AsRef<str>>(mut self, mesh_terms: &[S]) -> Self {
        for term in mesh_terms {
            self = self.mesh_term(term.as_ref());
        }
        self
    }

    /// Filter by MeSH subheading
    ///
    /// # Arguments
    ///
    /// * `subheading` - MeSH subheading to filter by
    ///
    /// # Example
    ///
    /// ```
    /// use pubmed_client_rs::pubmed::SearchQuery;
    ///
    /// let query = SearchQuery::new()
    ///     .mesh_term("Diabetes Mellitus")
    ///     .mesh_subheading("drug therapy");
    /// ```
    pub fn mesh_subheading<S: Into<String>>(mut self, subheading: S) -> Self {
        self.filters.push(format!("{}[sh]", subheading.into()));
        self
    }

    /// Filter by first author
    ///
    /// # Arguments
    ///
    /// * `author` - First author name to search for
    ///
    /// # Example
    ///
    /// ```
    /// use pubmed_client_rs::pubmed::SearchQuery;
    ///
    /// let query = SearchQuery::new()
    ///     .query("cancer treatment")
    ///     .first_author("Smith J");
    /// ```
    pub fn first_author<S: Into<String>>(mut self, author: S) -> Self {
        self.filters.push(format!("{}[1au]", author.into()));
        self
    }

    /// Filter by last author
    ///
    /// # Arguments
    ///
    /// * `author` - Last author name to search for
    ///
    /// # Example
    ///
    /// ```
    /// use pubmed_client_rs::pubmed::SearchQuery;
    ///
    /// let query = SearchQuery::new()
    ///     .query("genomics")
    ///     .last_author("Johnson M");
    /// ```
    pub fn last_author<S: Into<String>>(mut self, author: S) -> Self {
        self.filters.push(format!("{}[lastau]", author.into()));
        self
    }

    /// Filter by any author
    ///
    /// # Arguments
    ///
    /// * `author` - Author name to search for
    ///
    /// # Example
    ///
    /// ```
    /// use pubmed_client_rs::pubmed::SearchQuery;
    ///
    /// let query = SearchQuery::new()
    ///     .query("machine learning")
    ///     .author("Williams K");
    /// ```
    pub fn author<S: Into<String>>(mut self, author: S) -> Self {
        self.filters.push(format!("{}[au]", author.into()));
        self
    }

    /// Filter by institution/affiliation
    ///
    /// # Arguments
    ///
    /// * `institution` - Institution name to search for
    ///
    /// # Example
    ///
    /// ```
    /// use pubmed_client_rs::pubmed::SearchQuery;
    ///
    /// let query = SearchQuery::new()
    ///     .query("cardiology research")
    ///     .affiliation("Harvard Medical School");
    /// ```
    pub fn affiliation<S: Into<String>>(mut self, institution: S) -> Self {
        self.filters.push(format!("{}[ad]", institution.into()));
        self
    }

    /// Filter by ORCID identifier
    ///
    /// # Arguments
    ///
    /// * `orcid_id` - ORCID identifier to search for
    ///
    /// # Example
    ///
    /// ```
    /// use pubmed_client_rs::pubmed::SearchQuery;
    ///
    /// let query = SearchQuery::new()
    ///     .query("computational biology")
    ///     .orcid("0000-0001-2345-6789");
    /// ```
    pub fn orcid<S: Into<String>>(mut self, orcid_id: S) -> Self {
        self.filters.push(format!("{}[auid]", orcid_id.into()));
        self
    }

    /// Filter by organism using MeSH terms (scientific or common name)
    ///
    /// # Arguments
    ///
    /// * `organism` - Organism name (scientific or common name)
    ///
    /// # Examples
    ///
    /// ```
    /// use pubmed_client_rs::pubmed::SearchQuery;
    ///
    /// // Using scientific name
    /// let query = SearchQuery::new()
    ///     .query("gene expression")
    ///     .organism_mesh("Mus musculus");
    ///
    /// // Using common name
    /// let query = SearchQuery::new()
    ///     .query("metabolism")
    ///     .organism_mesh("Mice");
    ///
    /// // Using bacteria
    /// let query = SearchQuery::new()
    ///     .query("antibiotic resistance")
    ///     .organism_mesh("Escherichia coli");
    /// ```
    pub fn organism_mesh<S: Into<String>>(mut self, organism: S) -> Self {
        self.filters.push(format!("{}[mh]", organism.into()));
        self
    }

    /// Filter to human studies only
    ///
    /// # Example
    ///
    /// ```
    /// use pubmed_client_rs::pubmed::SearchQuery;
    ///
    /// let query = SearchQuery::new()
    ///     .query("drug treatment")
    ///     .human_studies_only();
    /// ```
    pub fn human_studies_only(mut self) -> Self {
        self.filters.push("humans[mh]".to_string());
        self
    }

    /// Filter to animal studies only
    ///
    /// # Example
    ///
    /// ```
    /// use pubmed_client_rs::pubmed::SearchQuery;
    ///
    /// let query = SearchQuery::new()
    ///     .query("preclinical research")
    ///     .animal_studies_only();
    /// ```
    pub fn animal_studies_only(mut self) -> Self {
        self.filters.push("animals[mh]".to_string());
        self
    }

    /// Filter by age group
    ///
    /// # Arguments
    ///
    /// * `age_group` - Age group to filter by (e.g., "Child", "Adult", "Aged")
    ///
    /// # Example
    ///
    /// ```
    /// use pubmed_client_rs::pubmed::SearchQuery;
    ///
    /// let query = SearchQuery::new()
    ///     .query("pediatric medicine")
    ///     .age_group("Child");
    /// ```
    pub fn age_group<S: Into<String>>(mut self, age_group: S) -> Self {
        self.filters.push(format!("{}[mh]", age_group.into()));
        self
    }

    /// Add a custom filter
    ///
    /// # Arguments
    ///
    /// * `filter` - Custom filter string in PubMed syntax
    ///
    /// # Example
    ///
    /// ```
    /// use pubmed_client_rs::pubmed::SearchQuery;
    ///
    /// let query = SearchQuery::new()
    ///     .query("research")
    ///     .custom_filter("humans[mh]");
    /// ```
    pub fn custom_filter<S: Into<String>>(mut self, filter: S) -> Self {
        self.filters.push(filter.into());
        self
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_mesh_term() {
        let query = SearchQuery::new().mesh_term("Neoplasms");
        assert_eq!(query.build(), "Neoplasms[mh]");
    }

    #[test]
    fn test_mesh_major_topic() {
        let query = SearchQuery::new().mesh_major_topic("Diabetes Mellitus, Type 2");
        assert_eq!(query.build(), "Diabetes Mellitus, Type 2[majr]");
    }

    #[test]
    fn test_multiple_mesh_terms() {
        let mesh_terms = ["Neoplasms", "Antineoplastic Agents"];
        let query = SearchQuery::new().mesh_terms(&mesh_terms);
        assert_eq!(query.build(), "Neoplasms[mh] AND Antineoplastic Agents[mh]");
    }

    #[test]
    fn test_mesh_subheading() {
        let query = SearchQuery::new()
            .mesh_term("Diabetes Mellitus")
            .mesh_subheading("drug therapy");
        assert_eq!(query.build(), "Diabetes Mellitus[mh] AND drug therapy[sh]");
    }

    #[test]
    fn test_first_author() {
        let query = SearchQuery::new().first_author("Smith J");
        assert_eq!(query.build(), "Smith J[1au]");
    }

    #[test]
    fn test_last_author() {
        let query = SearchQuery::new().last_author("Johnson M");
        assert_eq!(query.build(), "Johnson M[lastau]");
    }

    #[test]
    fn test_any_author() {
        let query = SearchQuery::new().author("Williams K");
        assert_eq!(query.build(), "Williams K[au]");
    }

    #[test]
    fn test_affiliation() {
        let query = SearchQuery::new().affiliation("Harvard Medical School");
        assert_eq!(query.build(), "Harvard Medical School[ad]");
    }

    #[test]
    fn test_orcid() {
        let query = SearchQuery::new().orcid("0000-0001-2345-6789");
        assert_eq!(query.build(), "0000-0001-2345-6789[auid]");
    }

    #[test]
    fn test_organism_mesh() {
        let query = SearchQuery::new().organism_mesh("Mus musculus");
        assert_eq!(query.build(), "Mus musculus[mh]");
    }

    #[test]
    fn test_organism_mesh_with_common_name() {
        let query = SearchQuery::new().organism_mesh("Mice");
        assert_eq!(query.build(), "Mice[mh]");
    }

    #[test]
    fn test_human_studies_only() {
        let query = SearchQuery::new().human_studies_only();
        assert_eq!(query.build(), "humans[mh]");
    }

    #[test]
    fn test_animal_studies_only() {
        let query = SearchQuery::new().animal_studies_only();
        assert_eq!(query.build(), "animals[mh]");
    }

    #[test]
    fn test_age_group() {
        let query = SearchQuery::new().age_group("Child");
        assert_eq!(query.build(), "Child[mh]");
    }

    #[test]
    fn test_custom_filter() {
        let query = SearchQuery::new().custom_filter("custom[field]");
        assert_eq!(query.build(), "custom[field]");
    }

    #[test]
    fn test_combined_advanced_filters() {
        let query = SearchQuery::new()
            .query("cancer treatment")
            .mesh_term("Neoplasms")
            .author("Smith J")
            .human_studies_only()
            .affiliation("Harvard");

        let expected =
            "cancer treatment AND Neoplasms[mh] AND Smith J[au] AND humans[mh] AND Harvard[ad]";
        assert_eq!(query.build(), expected);
    }

    #[test]
    fn test_empty_mesh_terms_array() {
        let mesh_terms: &[&str] = &[];
        let query = SearchQuery::new().mesh_terms(mesh_terms);
        assert_eq!(query.build(), "");
    }

    #[test]
    fn test_single_mesh_term_via_array() {
        let mesh_terms = ["Neoplasms"];
        let query = SearchQuery::new().mesh_terms(&mesh_terms);
        assert_eq!(query.build(), "Neoplasms[mh]");
    }

    #[test]
    fn test_mesh_term_with_spaces() {
        let query = SearchQuery::new().mesh_term("Diabetes Mellitus, Type 2");
        assert_eq!(query.build(), "Diabetes Mellitus, Type 2[mh]");
    }

    #[test]
    fn test_author_with_special_characters() {
        let query = SearchQuery::new().author("O'Connor J");
        assert_eq!(query.build(), "O'Connor J[au]");
    }

    #[test]
    fn test_affiliation_with_special_characters() {
        let query = SearchQuery::new().affiliation("Johns Hopkins & MIT");
        assert_eq!(query.build(), "Johns Hopkins & MIT[ad]");
    }

    #[test]
    fn test_custom_filter_preservation() {
        let query = SearchQuery::new()
            .custom_filter("first[custom]")
            .custom_filter("second[custom]");
        assert_eq!(query.build(), "first[custom] AND second[custom]");
    }
}