Skip to main content

AlertEngine

Struct AlertEngine 

Source
pub struct AlertEngine { /* private fields */ }
Expand description

Alert engine — holds rules and evaluates forecasts against them.

Implementations§

Source§

impl AlertEngine

Source

pub fn with_default_rules() -> Self

Create an alert engine with default rules for all metrics.

Source

pub const fn new() -> Self

Create an empty alert engine (no rules).

Source

pub fn add_rule(&mut self, rule: AlertRule)

Add a custom alert rule.

Source

pub fn rules(&self) -> &[AlertRule]

Get all rules.

Source

pub fn evaluate_rule(rule: &AlertRule, forecast: &Forecast) -> Option<Alert>

Evaluate a forecast against a rule. Returns an alert if triggered. Static version that doesn’t require &self (for use after releasing locks).

Source

pub fn evaluate(&self, rule: &AlertRule, forecast: &Forecast) -> Option<Alert>

Evaluate a forecast against a rule. Returns an alert if triggered.

Trait Implementations§

Source§

impl Default for AlertEngine

Source§

fn default() -> Self

Returns the “default value” for a type. 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> 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, 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.