ld-lucivy 0.26.1

BM25 search engine with cross-token fuzzy matching, substring search, regex, and highlights
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
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

use std::net::{IpAddr, Ipv6Addr};
use std::ops::BitOr;

use serde::{Deserialize, Serialize};

use super::flags::{FastFlag, IndexedFlag, SchemaFlagList, StoredFlag};

/// Trait to convert into an Ipv6Addr.
pub trait IntoIpv6Addr {
    /// Consumes the object and returns an Ipv6Addr.
    fn into_ipv6_addr(self) -> Ipv6Addr;
}

impl IntoIpv6Addr for IpAddr {
    fn into_ipv6_addr(self) -> Ipv6Addr {
        match self {
            IpAddr::V4(addr) => addr.to_ipv6_mapped(),
            IpAddr::V6(addr) => addr,
        }
    }
}

/// Define how an ip field should be handled by lucivy.
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize, Default)]
pub struct IpAddrOptions {
    fast: bool,
    stored: bool,
    indexed: bool,
    fieldnorms: bool,
}

impl IpAddrOptions {
    /// Returns true iff the value is a fast field.
    #[inline]
    pub fn is_fast(&self) -> bool {
        self.fast
    }

    /// Returns `true` if the ip address should be stored in the doc store.
    #[inline]
    pub fn is_stored(&self) -> bool {
        self.stored
    }

    /// Returns true iff the value is indexed and therefore searchable.
    #[inline]
    pub fn is_indexed(&self) -> bool {
        self.indexed
    }

    /// Returns true if and only if the value is normed.
    #[inline]
    pub fn fieldnorms(&self) -> bool {
        self.fieldnorms
    }

    /// Set the field as normed.
    ///
    /// Setting an integer as normed will generate
    /// the fieldnorm data for it.
    #[must_use]
    pub fn set_fieldnorms(mut self) -> Self {
        self.fieldnorms = true;
        self
    }

    /// Sets the field as stored
    #[must_use]
    pub fn set_stored(mut self) -> Self {
        self.stored = true;
        self
    }

    /// Set the field as indexed.
    ///
    /// Setting an ip address as indexed will generate
    /// a posting list for each value taken by the ip address.
    /// Ips are normalized to IpV6.
    ///
    /// This is required for the field to be searchable.
    #[must_use]
    pub fn set_indexed(mut self) -> Self {
        self.indexed = true;
        self
    }

    /// Set the field as a fast field.
    ///
    /// Fast fields are designed for random access.
    #[must_use]
    pub fn set_fast(mut self) -> Self {
        self.fast = true;
        self
    }
}

impl From<()> for IpAddrOptions {
    fn from(_: ()) -> IpAddrOptions {
        IpAddrOptions::default()
    }
}

impl From<FastFlag> for IpAddrOptions {
    fn from(_: FastFlag) -> Self {
        IpAddrOptions {
            fieldnorms: false,
            indexed: false,
            stored: false,
            fast: true,
        }
    }
}

impl From<StoredFlag> for IpAddrOptions {
    fn from(_: StoredFlag) -> Self {
        IpAddrOptions {
            fieldnorms: false,
            indexed: false,
            stored: true,
            fast: false,
        }
    }
}

impl From<IndexedFlag> for IpAddrOptions {
    fn from(_: IndexedFlag) -> Self {
        IpAddrOptions {
            fieldnorms: true,
            indexed: true,
            stored: false,
            fast: false,
        }
    }
}

impl<T: Into<IpAddrOptions>> BitOr<T> for IpAddrOptions {
    type Output = IpAddrOptions;

    fn bitor(self, other: T) -> IpAddrOptions {
        let other = other.into();
        IpAddrOptions {
            fieldnorms: self.fieldnorms | other.fieldnorms,
            indexed: self.indexed | other.indexed,
            stored: self.stored | other.stored,
            fast: self.fast | other.fast,
        }
    }
}

impl<Head, Tail> From<SchemaFlagList<Head, Tail>> for IpAddrOptions
where
    Head: Clone,
    Tail: Clone,
    Self: BitOr<Output = Self> + From<Head> + From<Tail>,
{
    fn from(head_tail: SchemaFlagList<Head, Tail>) -> Self {
        Self::from(head_tail.head) | Self::from(head_tail.tail)
    }
}