Skip to main content

PressureEngine

Struct PressureEngine 

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

Derives the Pressure Radar from a stream of snapshots (§2.3).

Stateful on purpose: hysteresis is memory, and §11.3 requires it. The state is bounded — one fixed-length observation window per signal — so a twelve-hour run occupies exactly as much as the first minute (§16.1).

Implementations§

Source§

impl PressureEngine

Source

pub fn new(thresholds: Thresholds) -> Self

Builds an engine from configuration, sanitizing it first.

Source

pub const fn thresholds(&self) -> &Thresholds

The sanitized thresholds in effect.

Source

pub fn set_thresholds(&mut self, thresholds: Thresholds)

Replaces the thresholds, discarding hysteresis state.

§12 makes configuration reload atomic. The observations already collected were judged against the old thresholds, so keeping them would let a reload produce a state that neither configuration justifies; a reset is the honest answer and costs one warm-up period.

Source

pub fn reset(&mut self)

Discards every signal’s hysteresis state (§11.3).

The runtime calls this after anything that breaks the continuity of the measurement stream and that the engine cannot see for itself — a collector restart, for instance. Sleep/wake gaps are detected automatically by Self::observe.

Source

pub const fn observations(&self) -> u64

How many snapshots have been folded into the current state.

Source

pub const fn discontinuities(&self) -> u64

How many measurement discontinuities have been absorbed (§11.3).

Surfaced on the Inspect screen so a user who closed their laptop can see why the radar went back to warming up (§7.5).

Source

pub fn observe(&mut self, snapshot: &SystemSnapshot) -> PressureSnapshot

Folds one snapshot in and returns the radar the UI should render.

The returned snapshot’s psi is the one from snapshot: raw PSI is the collector’s measurement and is passed through unchanged.

Trait Implementations§

Source§

impl Clone for PressureEngine

Source§

fn clone(&self) -> PressureEngine

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 PressureEngine

Source§

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

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

impl Default for PressureEngine

Source§

fn default() -> Self

An engine with the §12 default thresholds.

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> 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.