Skip to main content

WindowState

Enum WindowState 

Source
pub enum WindowState {
    EventCount {
        timestamps: VecDeque<i64>,
    },
    ValueCount {
        entries: VecDeque<(i64, String)>,
    },
    Temporal {
        rule_hits: HashMap<String, VecDeque<i64>>,
    },
    NumericAgg {
        entries: VecDeque<(i64, f64)>,
    },
}
Expand description

Per-group mutable state within a time window.

Each variant matches the type of aggregation being performed.

Variants§

§

EventCount

For event_count: timestamps of matching events.

Fields

§timestamps: VecDeque<i64>
§

ValueCount

For value_count: (timestamp, field_value) pairs.

Fields

§entries: VecDeque<(i64, String)>
§

Temporal

For temporal / temporal_ordered: rule_ref -> list of hit timestamps.

Fields

§

NumericAgg

For value_sum, value_avg, value_percentile, value_median: (timestamp, numeric_value) pairs.

Fields

§entries: VecDeque<(i64, f64)>

Implementations§

Source§

impl WindowState

Source

pub fn new_for(corr_type: CorrelationType) -> Self

Create a new empty window state for the given correlation type.

Source

pub fn evict(&mut self, cutoff: i64)

Remove all entries older than the cutoff timestamp.

Source

pub fn is_empty(&self) -> bool

Returns true if this state has no entries.

Source

pub fn latest_timestamp(&self) -> Option<i64>

Returns the most recent timestamp in this window, or None if empty.

Source

pub fn earliest_timestamp(&self) -> Option<i64>

Returns the oldest timestamp in this window, or None if empty.

Entries are appended in arrival order, so the front of each deque holds the earliest timestamp. For temporal state the minimum is taken across all per-rule deques.

Source

pub fn truncate_oldest(&mut self, cap: usize, preserve_front: bool)

Enforce a per-group entry cap by dropping the oldest entries.

cap is the maximum number of retained entries (clamped to at least 1). For temporal state the cap applies to each referenced rule’s hit deque independently, since the deques are what grow with event rate.

When preserve_front is set (session windows), the oldest entry is kept and truncation happens behind it: the front entry anchors the session’s total-span cap (timespan), so dropping it would silently let the session extend past the cap. Truncation can only under-count; it never extends a window.

Source

pub fn clear(&mut self)

Clear all entries from the window state (used by CorrelationAction::Reset).

Source

pub fn push_event_count(&mut self, ts: i64)

Record an event_count hit.

Source

pub fn push_value_count(&mut self, ts: i64, value: String)

Record a value_count hit with the field value.

Source

pub fn push_temporal(&mut self, ts: i64, rule_ref: &str)

Record a temporal hit for a specific rule reference.

Source

pub fn push_numeric(&mut self, ts: i64, value: f64)

Record a numeric aggregation value.

Source

pub fn check_condition( &self, condition: &CompiledCondition, corr_type: CorrelationType, rule_refs: &[String], extended_expr: Option<&ConditionExpr>, ) -> Option<f64>

Evaluate the window state against the correlation condition.

Returns Some(aggregated_value) if the condition is satisfied, None otherwise.

For temporal correlations with an extended expression, the expression is evaluated against the set of rules that have fired in the window.

Source§

impl WindowState

Source

pub fn entry_count(&self) -> usize

Number of retained entries in this window. For temporal state this is the total across all per-rule hit deques.

Source

pub fn current_value( &self, corr_type: CorrelationType, rule_refs: &[String], percentile: Option<u64>, ) -> Option<f64>

Compute the current aggregate value for this window without applying the correlation’s threshold condition.

Unlike check_condition, which returns None when the threshold is not met, this returns the raw “got” value the introspection surface reports so an operator can see the gap to the threshold. Returns None only when no value is defined (an empty percentile/median window, or a state/type mismatch).

Trait Implementations§

Source§

impl Clone for WindowState

Source§

fn clone(&self) -> WindowState

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for WindowState

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for WindowState

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for WindowState

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

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> 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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.