tracing_capture/predicates/
mod.rs

Help
1//! Predicates for [`CapturedSpan`]s and [`CapturedEvent`]s.
2//!
3//! # Overview
4//!
5//! A predicate can be created with the functions from this module:
6//!
7//! - [`level()`] checks the span / event level
8//! - [`name()`] checks the span name
9//! - [`target()`] checks the span / event target
10//! - [`field()`] checks a specific span / event field
11//! - [`message()`] checks the event message
12//! - [`parent()`] checks the direct parent span of an event / span
13//! - [`ancestor()`] checks the ancestor spans of an event / span
14//!
15//! These predicates can be combined with bitwise operators, `&` and `|`.
16//! The [`ScanExt`] trait may be used to simplify assertions with predicates. The remaining
17//! traits and structs are lower-level plumbing and rarely need to be used directly.
18//!
19//! [`CapturedSpan`]: crate::CapturedSpan
20//! [`CapturedEvent`]: crate::CapturedEvent
21//!
22//! # Examples
23//!
24//! ```
25//! # use tracing_core::Level;
26//! # use predicates::ord::eq;
27//! # use tracing_capture::{predicates::*, Storage};
28//! # fn test_wrapper(storage: &Storage) {
29//! // Predicates can be combined using bitwise operators:
30//! let predicate = target([eq("tracing")])
31//!     & name(eq("test_capture"))
32//!     & level(Level::INFO)
33//!     & field("result", 42_i64);
34//! // The resulting predicate can be used with `CapturedExt` trait.
35//! let storage: &Storage = // ...
36//! #   storage;
37//! let _ = storage.scan_spans().first(&predicate);
38//! let _ = storage.scan_events().single(&level(Level::ERROR));
39//!
40//! // ...or converted back to a closure:
41//! let _ = storage.all_spans().filter(into_fn(predicate));
42//! # }
43//! ```
44
45use predicates::Predicate;
46
47#[macro_use]
48mod combinators;
49mod ext;
50mod field;
51mod level;
52mod name;
53mod parent;
54mod target;
55
56#[cfg(test)]
57mod tests;
58
59pub use self::{
60    combinators::{And, Or},
61    ext::{ScanExt, Scanner},
62    field::{
63        field, message, value, FieldPredicate, IntoFieldPredicate, MessagePredicate, ValuePredicate,
64    },
65    level::{level, IntoLevelPredicate, LevelPredicate},
66    name::{name, NamePredicate},
67    parent::{ancestor, parent, AncestorPredicate, ParentPredicate},
68    target::{target, IntoTargetPredicate, TargetPredicate},
69};
70
71/// Converts a predicate into an `Fn(_) -> bool` closure.
72///
73/// This can be used in APIs (e.g., [`Iterator`] combinators) that expect a closure
74/// as an argument.
75///
76/// # Examples
77///
78/// ```
79/// # use tracing_core::Level;
80/// # use tracing_capture::{predicates::*, CapturedEvent};
81/// let predicate = into_fn(target("tracing") & level(Level::INFO));
82/// let events: &[CapturedEvent] = // ...
83/// #   &[];
84/// let matching_events = events.iter().copied().filter(predicate);
85/// // Do something with `matching_events`...
86/// ```
87pub fn into_fn<Item>(predicate: impl Predicate<Item>) -> impl Fn(&Item) -> bool {
88    move |variable| predicate.eval(variable)
89}
tracing_capture/predicates/mod.rs

tracing_capture/predicates/
mod.rs
