Skip to main content

RuleSet

Struct RuleSet 

Source
pub struct RuleSet<'a> { /* private fields */ }
Available on crate feature decode only.
Expand description

A set of rules judged tick by tick over one event stream — the watchdog’s per-tick body, lifted out of watchdog so a second driver can run it (#218).

The driver owns the stream, the drain loop and the sweep; this owns everything the rules know: per-rule counters, the last sample and drop instants, the per-tick decode budget, and the transition detectors. Feed it every sample (observe_sample) and every drop (observe_drop) the stream yields, then evaluate once per tick and get back only what changed.

Why the seam exists. A trigger capture (zenctl record --on) must judge the same event stream it records: one subscription, one drop ledger. Had the capture run a watchdog of its own beside its recorder, the drops the judge saw and the drops in the file would have been two different facts about two different observers — and a {"dropped": n} in the file would say nothing about whether the rule that fired was judged over a clean window. With the body a value, the recorder drains one stream and hands every item to both the ring and the rules.

Sample attribution is by key-expression intersection against each rule’s selector; a sample whose key does not parse as one counts for no rule. Time is tokio::time::Instant, so a driver under paused time judges exact windows.

Implementations§

Source§

impl<'a> RuleSet<'a>

Source

pub fn new( rules: &[Condition], base: &'a str, slices: Option<&'a SliceSet>, ) -> Result<Self>

Compile the rules. Fails on a selector that is not a key expression — before anything is declared, so the ? has nothing to tear down (#336). The watch clock starts here: CondWindow::observed_s is measured from construction, so build the set right before the subscriptions are declared.

Source

pub fn watched(&self) -> &[String]

The distinct selectors the rules observe — what the driver must subscribe to before the first window opens (O4).

Source

pub fn wants_doctor(&self) -> bool

Some rule judges a doctor run, so the driver owes one per tick.

Source

pub fn wants_roster(&self) -> bool

Some rule judges the liveliness roster, so the driver owes one ask per tick.

Source

pub fn wants_decode(&self) -> bool

Some rule judges payload validity, so the driver owes a warmed, sealed schema store (#337) and a decode per wants_verdict.

Source

pub fn wants_verdict(&mut self, s: &SampleView) -> bool

Whether this sample should be decoded before it is observed: an invalid-payload rule matches its key and the key’s per-tick decode budget has room. Spends the budget — ask once per sample, then hand the verdict to observe_sample. The decode stays the driver’s, because it is async and this is not.

Source

pub fn observe_sample( &mut self, s: &SampleView, facts_cache: &mut FactsCache, verdict: Option<&Verdict>, )

Count one observed sample against every rule its key matches. verdict is the decode the driver ran when wants_verdict said so; None means the sample was not checked, which is counted as exactly that.

Source

pub fn observe_drop(&mut self, n: u64)

The stream dropped n samples here (RFC 09 §5.1 O6): unattributable to any one selector, so it taints every completeness claim this tick.

Source

pub fn evaluate( &mut self, now: Instant, at: &str, sweep: SweepOutcome<'_>, ) -> Vec<Transition>

Close the tick: judge every rule over the window measured since the last evaluation, reset the per-tick counts, and hand back only the genuine changes — none for an unchanged rule. at is the wall-clock stamp the transitions carry.

Source

pub fn ticks(&self) -> u64

Ticks evaluated so far.

Source

pub fn last_eval(&self) -> Instant

When the last tick closed (construction, before the first): the driver’s next deadline is measured from here, so a slow consumer of the transitions widens the next window rather than skipping one.

Source

pub fn transitions(&self) -> u64

Transitions emitted so far.

Auto Trait Implementations§

§

impl<'a> Freeze for RuleSet<'a>

§

impl<'a> RefUnwindSafe for RuleSet<'a>

§

impl<'a> Send for RuleSet<'a>

§

impl<'a> Sync for RuleSet<'a>

§

impl<'a> Unpin for RuleSet<'a>

§

impl<'a> UnsafeUnpin for RuleSet<'a>

§

impl<'a> UnwindSafe for RuleSet<'a>

Blanket Implementations§

Source§

impl<Source> AccessAs for Source

Source§

fn ref_as<T>(&self) -> <Source as IGuardRef<T>>::Guard<'_>
where Source: IGuardRef<T>, T: ?Sized,

Provides immutable access to a type as if it were its ABI-unstable equivalent.
Source§

fn mut_as<T>(&mut self) -> <Source as IGuardMut<T>>::GuardMut<'_>
where Source: IGuardMut<T>, T: ?Sized,

Provides mutable access to a type as if it were its ABI-unstable equivalent.
Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> AsNode<T> for T

Source§

fn as_node(&self) -> &T

Source§

impl<T> AsNodeMut<T> for T

Source§

fn as_node_mut(&mut self) -> &mut T

Source§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, As> IGuardMut<As> for T
where T: Into<As>, As: Into<T>,

Source§

type GuardMut<'a> = MutAs<'a, T, As> where T: 'a

The type of the guard which will clean up the temporary after applying its changes to the original.
Source§

fn guard_mut_inner(&mut self) -> <T as IGuardMut<As>>::GuardMut<'_>

Construct the temporary and guard it through a mutable reference.
Source§

impl<T, As> IGuardRef<As> for T
where T: Into<As>, As: Into<T>,

Source§

type Guard<'a> = RefAs<'a, T, As> where T: 'a

The type of the guard which will clean up the temporary.
Source§

fn guard_ref_inner(&self) -> <T as IGuardRef<As>>::Guard<'_>

Construct the temporary and guard it through an immutable reference.
Source§

impl<T> Includes<End> for T

Source§

type Output = End

The result
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more