rs-es 0.12.3

Client for the ElasticSearch REST 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

/*
 * Copyright 2015-2018 Ben Ashford
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

//! Implementations of specific ElasticSearch operations
//!
//! The various methods on [`Client`](../struct.Client.html) are entry points to
//! ElasticSearch's set of operations.  This module, and it's child modules are
//! the implementation of those operations.

use std::borrow::Cow;

use serde::{Serialize, Deserialize};

use crate::util::StrJoin;

// Specific operations
#[macro_use]
pub mod common;

pub mod analyze;
pub mod bulk;
pub mod delete;
pub mod delete_index;
pub mod get;
pub mod index;
pub mod mapping;
pub mod refresh;
pub mod search;
pub mod version;

// Common utility functions

/// A repeating convention in the ElasticSearch REST API is parameters that can
/// take multiple values
fn format_multi<'a>(parts: &[&'a str]) -> Cow<'a, str> {
    match parts.len() {
        0 => Cow::Borrowed("_all"),
        1 => Cow::Borrowed(parts[0]),
        _ => Cow::Owned(parts.iter().join(",")),
    }
}

/// Multiple operations require indexes and types to be specified, there are
/// rules for combining the two however.  E.g. all indexes is specified with
/// `_all`, but all types are specified by omitting type entirely.
fn format_indexes_and_types<'a>(indexes: &[&'a str], types: &[&str]) -> Cow<'a, str> {
    if types.is_empty() {
        format_multi(indexes)
    } else {
        Cow::Owned(format!("{}/{}", format_multi(indexes), format_multi(types)))
    }
}

// Results

/// Shared struct for operations that include counts of success/failed shards.
/// This is returned within various other result structs.
#[derive(Debug, Deserialize, Serialize)]
pub struct ShardCountResult {
    pub total: u64,
    pub successful: u64,
    pub failed: u64,
}

#[derive(Debug, Deserialize)]
pub struct GenericResult {
    pub acknowledged: bool,
}