entrez-rs 0.1.4

Rust wrapper for the Entrez API
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

//! Utilities to parse XML results obtained using [ESearch](super::super::eutils::ESearch).
 
//! # Description
//! When using [ESearch](super::super::eutils::ESearch),
//! the resulting XML
//! is as follows:
//! ``` xml
//! <?xml version="1.0" encoding="UTF-8" ?>
//! <!DOCTYPE eSearchResult PUBLIC "-//NLM//DTD esearch 20060628//EN" "https://eutils.ncbi.nlm.nih.gov/eutils/dtd/20060628/esearch.dtd">
//! <eSearchResult>
//!    ...
//! </eSearchResult>
//!  ```
//! The [read](ESearchResult::read) function will parse this XML into an [ESearchResult]
//! struct.
//! 
//! # Example
//! 
//!  ```
//!   use entrez_rs::eutils::{Eutils, ESearch, DB};
//!   use entrez_rs::parser::esearch::{ESearchResult};
//! 
//!   let xml = ESearch::new(
//!         DB::Pubmed, 
//!         "sars_cov_2") 
//!         .run().expect("Connection error");
//! 
//!   // Use the read function to parse the xml result.
//!   let parsed = ESearchResult::read(&xml)
//!                .expect("Parsing error");
//! 
//!   assert_eq!(parsed.id_list.ids.len(), 20);
//!   ```


extern crate serde;
extern crate quick_xml;
use serde::{Deserialize};
use quick_xml::de::{from_str, DeError};


#[derive(Debug, Deserialize, PartialEq)]
pub struct IdList {
    #[serde(rename = "Id", default)]
    pub ids: Vec<String>
}

#[derive(Debug, Deserialize, PartialEq)]
pub struct Translation {
    #[serde(rename = "From", default)]
    pub from: String,
    #[serde(rename = "To", default)]
    pub to: String,
}

#[derive(Debug, Deserialize, PartialEq)]
pub struct TranslationSet {
    #[serde(rename = "Translation")]
    pub translation: Vec<Translation>
}

#[derive(Debug, Deserialize, PartialEq)]
pub struct TranslationStack {
    #[serde(rename = "TermSet")]
    pub term_set: Vec<TermSet>,
    #[serde(rename = "OP")]
    pub op: Vec<String>,
}

#[derive(Debug, Deserialize, PartialEq)]
pub struct TermSet {
    #[serde(rename = "Term", default)]
    pub term: String,
    #[serde(rename = "Field", default)]
    pub field: String,
    #[serde(rename = "Count", default)]
    pub count: u64,
    #[serde(rename = "Explode", default)]
    pub explode: String,
}


#[derive(Debug, Deserialize, PartialEq)]
pub struct ESearchResult {
    #[serde(rename = "Count", default)]
    pub count: u64,
    #[serde(rename = "RetMax", default)]
    pub ret_max: u64,
    #[serde(rename = "RetStart", default)]
    pub ret_start: u64,
    #[serde(rename = "QueryKey", default)]
    pub query_key: u64,
    #[serde(rename = "WebEnv", default)]
    pub web_env: String,
    #[serde(rename = "IdList")]
    pub id_list: IdList,
   // #[serde(rename = "TranslationSet")]
   // translation_set: TranslationSet,
  //  #[serde(rename = "TranslationStack")]
  //  translation_stack: TranslationStack,
    #[serde(rename = "QueryTranslation", default)]
    pub query_translation: String,
}

impl ESearchResult {
    pub fn read(xml: &str) -> Result<ESearchResult, DeError> {
        from_str(xml)
    }
}