opensearch-dsl 0.3.1

Strongly typed OpenSearch DSL
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

use crate::{util::ShouldSkip, Fuzziness};

/// Suggester fuzziness parameters
#[derive(Debug, Default, Clone, Copy, PartialEq, Eq, Deserialize, Serialize)]
pub struct SuggestFuzziness {
    #[serde(default, skip_serializing_if = "ShouldSkip::should_skip")]
    fuzziness: Option<Fuzziness>,

    #[serde(default, skip_serializing_if = "ShouldSkip::should_skip")]
    min_length: Option<u64>,

    #[serde(default, skip_serializing_if = "ShouldSkip::should_skip")]
    prefix_length: Option<u64>,

    #[serde(default, skip_serializing_if = "ShouldSkip::should_skip")]
    transpositions: Option<bool>,

    #[serde(default, skip_serializing_if = "ShouldSkip::should_skip")]
    unicode_aware: Option<bool>,
}

impl SuggestFuzziness {
    /// Creates a new instance of [SuggestFuzziness]
    pub fn new() -> Self {
        Default::default()
    }

    /// The fuzziness factor, defaults to [`AUTO`](Fuzziness::Auto). See
    /// [Fuzziness] for allowed settings.
    pub fn fuzziness<T>(mut self, fuzziness: T) -> Self
    where
        T: Into<Fuzziness>,
    {
        self.fuzziness = Some(fuzziness.into());
        self
    }

    /// If set to `true`, transpositions are counted as one change instead of two,
    /// defaults to `true`
    pub fn transpositions(mut self, transpositions: bool) -> Self {
        self.transpositions = Some(transpositions);
        self
    }

    /// Minimum length of the input before fuzzy suggestions are returned,
    /// defaults `3`
    pub fn min_length(mut self, min_length: u64) -> Self {
        self.min_length = Some(min_length);
        self
    }

    /// Minimum length of the input, which is not checked for fuzzy alternatives,
    /// defaults to `1`
    pub fn prefix_length(mut self, prefix_length: u64) -> Self {
        self.prefix_length = Some(prefix_length);
        self
    }

    /// If `true`, all measurements (like fuzzy edit distance, transpositions, and
    /// lengths) are measured in Unicode code points instead of in bytes. This
    /// is slightly slower than raw bytes, so it is set to `false` by default.
    pub fn unicode_aware(mut self, unicode_aware: bool) -> Self {
        self.unicode_aware = Some(unicode_aware);
        self
    }
}