aboutsummaryrefslogtreecommitdiff
path: root/src/lib.rs
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib.rs')
-rw-r--r--src/lib.rs59
1 files changed, 59 insertions, 0 deletions
diff --git a/src/lib.rs b/src/lib.rs
new file mode 100644
index 0000000..60e05d3
--- /dev/null
+++ b/src/lib.rs
@@ -0,0 +1,59 @@
+//! Parses and evaluates [AIP-160](https://google.aip.dev/160) filter expressions.
+//!
+//! ## Example
+//!
+//! ```rust
+//! use aip_filter::{parse, Value, Filterable};
+//!
+//! let expr = parse("state = \"open\" AND priority > 3").unwrap().unwrap();
+//! println!("{}", expr);
+//! ```
+//!
+//! ## Evaluating filters
+//!
+//! Implement [`Filterable`] for your type, then call [`Expr::evaluate`]:
+//!
+//! ```rust
+//! use aip_filter::{parse, Value, Filterable};
+//!
+//! struct Issue {
+//! state: String,
+//! priority: i64,
+//! labels: Vec<String>,
+//! }
+//!
+//! impl Filterable for Issue {
+//! fn field(&self, name: &str) -> Option<Value<'_>> {
+//! match name {
+//! "state" => Some(Value::String(&self.state)),
+//! "priority" => Some(Value::Int(self.priority)),
+//! "labels" => Some(Value::List(
+//! self.labels.iter().map(|l| Value::String(l)).collect()
+//! )),
+//! _ => None,
+//! }
+//! }
+//! }
+//!
+//! let expr = parse("state = \"open\"").unwrap().unwrap();
+//! let issue = Issue { state: "open".into(), priority: 1, labels: vec![] };
+//! assert!(expr.evaluate(&issue));
+//! ```
+
+pub mod ast;
+pub mod display;
+pub mod eval;
+pub mod lex;
+pub mod parser;
+
+pub use ast::{BinaryOp, CompareOp, Expr, Position, UnaryOp};
+pub use eval::{Filterable, Value};
+
+/// Parse a filter expression string into an [`Expr`] AST.
+///
+/// Returns `Ok(None)` for empty/whitespace-only input.
+/// Returns `Ok(Some(expr))` on success.
+/// Returns `Err(message)` on parse errors.
+pub fn parse(input: &str) -> Result<Option<Expr>, String> {
+ parser::parse_filter(input)
+}