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
// Copyright (c) 2025-2026 Zensical and contributors
// SPDX-License-Identifier: MIT
// All contributions are certified under the DCO
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to
// deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
// IN THE SOFTWARE.
// ----------------------------------------------------------------------------
//! Filter.
use Slab;
use Matcher;
pub use Builder;
pub use Candidates;
use Condition;
pub use ;
pub use ;
pub use Terms;
// ----------------------------------------------------------------------------
// Structs
// ----------------------------------------------------------------------------
/// Filter.
///
/// Filters efficiently match identifiers against a set of expressions, which
/// are composed of conditions and logical operators, and compiled into a set
/// of optimized instructions. This makes it possible to evaluate arbitrarily
/// complex logical expressions against identifiers extremely fast.
///
/// Each [`Filter`] manages a [`Matcher`], used to identify matching terms in
/// expressions in nanoseconds, and a set of conditions built from expressions,
/// which are checked for satisfiability by using a bitwise stack-based virtual
/// machine with an optimized set of instructions. Thus, the [`Matcher`] can be
/// thought of as the first stage, eliminating non-matching expressions, while
/// the condition set is the second stage, which checks whether the remaining
/// expressions are actually satisfied by the identifier.
///
/// # Examples
///
/// ```
/// # use std::error::Error;
/// # fn main() -> Result<(), Box<dyn Error>> {
/// use zrx_id::{selector, Expression, Filter, Id};
///
/// // Create filter builder and insert expression
/// let mut builder = Filter::builder();
/// builder.insert(Expression::all(|expr| {
/// expr.with(selector!(location = "**/*.md")?)?
/// .with(selector!(provider = "file")?)
/// })?);
///
/// // Create filter from builder
/// let filter = builder.build()?;
///
/// // Create identifier and obtain candidate expressions
/// let id: Id = "zri:file:::docs:index.md:".parse()?;
/// for index in filter.candidates(&id)? {
/// println!("{index:?}");
/// }
/// # Ok(())
/// # }
/// ```
// ----------------------------------------------------------------------------
// Implementations
// ----------------------------------------------------------------------------