logo
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

use serde::{Serialize, Serializer};
use std::ops::Range;

/// Some queries and APIs support parameters to allow inexact _fuzzy_ matching,
/// using the `fuzziness` parameter.
///
/// When querying `text` or `keyword` fields, `fuzziness` is interpreted as a
/// [Levenshtein Edit Distance](https://en.wikipedia.org/wiki/Levenshtein_distance)
/// — the number of one character changes that need to be made to one string to make it the same as another string.
///
/// <https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#fuzziness>
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum Fuzziness {
    /// Generates an edit distance based on the length of the term.
    ///
    /// `AUTO` should generally be the preferred value for `fuzziness`.
    Auto,

    /// Low and high distance arguments may be optionally provided
    /// `AUTO:[low],[high]`. If not specified, the default values are 3 and 6,
    /// equivalent to `AUTO:3,6` that make for lengths:
    ///
    /// **`0..2`**
    ///
    /// &nbsp;&nbsp;&nbsp;&nbsp;Must match exactly
    ///
    /// **`3..5`**
    ///
    /// &nbsp;&nbsp;&nbsp;&nbsp;One edit allowed
    ///
    /// **`>5`**
    ///
    /// &nbsp;&nbsp;&nbsp;&nbsp;Two edits allowed
    Range(u8, u8),

    /// The maximum allowed Levenshtein Edit Distance (or number of edits)
    Distance(u8),
}

impl Serialize for Fuzziness {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        match self {
            Self::Auto => "AUTO".serialize(serializer),
            Self::Range(start, end) => format!("AUTO:{},{}", start, end).serialize(serializer),
            Self::Distance(d) => d.serialize(serializer),
        }
    }
}

impl From<Range<u8>> for Fuzziness {
    fn from(v: Range<u8>) -> Self {
        Self::Range(v.start, v.end)
    }
}

impl From<[u8; 2]> for Fuzziness {
    fn from(v: [u8; 2]) -> Self {
        Self::Range(v[0], v[1])
    }
}

impl From<u8> for Fuzziness {
    fn from(v: u8) -> Self {
        Self::Distance(v)
    }
}

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

    #[test]
    fn implements_from_u8() {
        let result = Fuzziness::from(8);

        let expectation = Fuzziness::Distance(8);

        assert_eq!(result, expectation);
    }

    #[test]
    fn implements_from_range_u8() {
        let result = Fuzziness::from(0..2);

        let expectation = Fuzziness::Range(0, 2);

        assert_eq!(result, expectation);
    }

    #[test]
    fn serializes() {
        assert_serialize(
            [
                Fuzziness::Auto,
                Fuzziness::Range(0, 2),
                Fuzziness::Distance(5),
            ],
            json!(["AUTO", "AUTO:0,2", 5,]),
        )
    }
}