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
/*!
Elasticsearch Response Iterators

A crate to handle parsing and handling Elasticsearch search results which provides
convenient iterators to step through the results returned. It is designed to work
with [`elastic-reqwest`][elastic-reqwest].
It also re-exports `serde_json::Value` for convenient anonymous json objects.

This crate provides parsers that can be used to convert a http response into a concrete
type or an API error.

## Usage

This crate is on [crates.io][crates-io].
Add `elastic_responses` to your `Cargo.toml`:

```text
[dependencies]
elastic_responses = "*"
```

Use the [`parse`][parse] function to deserialise a http response to a `Result<T, ApiError>` for some
concrete response type `T`.

# Examples

Run a [Query DSL][query-dsl] query, then iterate through the results:

```no_run
# extern crate elastic_responses;
# use elastic_responses::*;
# fn do_request() -> (u16, Vec<u8>) { unimplemented!() }
# fn main() {
// Send a search request and read as a response
let (response_status, response_body) = do_request();

// Parse body to JSON as an elastic_responses::SearchResponse object
// If the response is an API error then it'll be parsed into a friendly Rust error
let response = parse::<SearchResponse<Value>>().from_slice(response_status, response_body).unwrap();

// Iterate over hits. Could also use `documents`
for hit in response.hits() {
    let score = hit.score().unwrap_or(f32::default());
    let doc = hit.document();
    
    println!("score: {}", score);
    println!("doc: {:?}", doc);
}

// Agregations are flattened into individual stats metrics
for agg in response.aggs() {
    let min_ack_pkts = agg["min_ack_pkts_sent"].as_u64().unwrap();
    let max_ack_pkts = agg["max_ack_pkts_sent"].as_u64().unwrap();
    
    println!("min: {}, max: {}", min_ack_pkts, max_ack_pkts);
}
# }
```

Any type that implements `Deserialize` can be used as the document type in the search response:

```no_run
# #[macro_use] extern crate serde_derive;
# extern crate serde;
# extern crate elastic_responses;
# use elastic_responses::*;
# fn do_request() -> (u16, Vec<u8>) { unimplemented!() }
# fn main() {
#[derive(Deserialize)]
struct MyDocument {
    title: String,
    description: String
}

let (response_status, response_body) = do_request();

let response = parse::<SearchResponse<MyDocument>>().from_slice(response_status, response_body).unwrap();

for doc in response.documents() {
    println!("title: {}", doc.title);
    println!("description: {}", doc.description);
}
# }
```

Run a [Get Document][get-document] request, and handle cases where the document wasn't found or the index doesn't exist:

```no_run
# extern crate serde_json;
# extern crate elastic_responses;
# use serde_json::Value;
# use elastic_responses::*;
# use elastic_responses::error::*;
# fn do_request() -> (u16, Vec<u8>) { unimplemented!() }
# fn main() {
// Send a document get request and read as a response
let (response_status, response_body) = do_request();

let response = parse::<GetResponse<Value>>().from_slice(response_status, response_body);

match response.map(|res| res.into_document()) {
    Ok(Some(doc)) => {
        // The document was found
    }
    Ok(None) => {
        // The document was not found
    }
    Err(ResponseError::Api(ApiError::IndexNotFound { index })) => {
        // The index doesn't exist
    }
    _ => {
        // Some other error
    }
}
# }
```

As with `SearchResponse`, any type that implements `Deserialize` can be used as the generic document type
in a `GetResponse`.

[elastic-reqwest]: https://github.com/elastic-rs/elastic-reqwest/
[crates-io]: https://crates.io/crates/elastic_responses
[query-dsl]: https://www.elastic.co/guide/en/elasticsearch/reference/current/search.html
[get-document]: https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html
[parse]: parsing/fn.parse.html
*/

#[deny(warnings, missing_docs)]

#[macro_use]
extern crate serde_derive;

#[macro_use]
extern crate quick_error;

extern crate serde;
#[macro_use]
extern crate serde_json;

pub mod error;
pub mod parsing;

mod common;
mod command;
mod ping;
mod get;
mod delete;
mod update;
pub mod search;
pub mod bulk;
mod index;

mod indices_exists;

pub use self::common::*;
pub use self::command::*;
pub use self::ping::*;
pub use self::get::*;
pub use self::delete::*;
pub use self::update::*;
pub use self::search::SearchResponse;
pub use self::bulk::{BulkErrorsResponse, BulkResponse};
pub use self::index::*;

pub use self::indices_exists::*;

pub use self::parsing::parse;

/** Re-export of `serde_json::Value` for convenience. */
pub use serde_json::Value;