Struct charts::filter::Filters

pub struct Filters { /* private fields */ }

A list of filters.

Aggregates the following:

• a “catch all” FilterSpec, the specification for the points that no filter catches;
• a “everything” FilterSpec, the specification for all the points, regardless of user-defined filters;
• a list of Filters;
• a memory from allocation UIDs to filter UIDs that tells which filter takes care of some allocation.

The point of the memory is that it is not possible to know which filter takes care of a given allocation after the first time we saw that allocation. Which we want to know when registering the death of an allocation. The reason we don’t know is that new filters might have been introduced or some filters may have changed. Hence the filter assigned for this allocation a while ago may not be the one we would assign now.

Implementations

impl Filters

pub fn new() -> Self

Constructor.

pub fn new_with(filters: Vec<Filter>) -> Self

Constructor.

pub fn catch_all(&self) -> &FilterSpec

Specification of the catch_all filter.

pub fn everything(&self) -> &FilterSpec

Specification of the everything filter.

pub fn filters(&self) -> &Vec<Filter>

Specifications of the custom filters.

pub fn auto_gen(
    data: &Data,
    generator: impl Into<FilterGen>
) -> Res<(Self, Vec<Chart>)>

Runs filter generation.

Returns the number of filter generated.

pub fn len(&self) -> usize

Length of the list of filters.

pub fn get_spec_mut(&mut self, uid: Option<Filter>) -> Res<&mut FilterSpec>

Filter specification mutable accessor.

pub fn get_mut(&mut self, uid: Filter) -> Res<(usize, &mut Filter)>

Filter mutable accessor.

• returns the index of the filter and the filter itself;
• fails if the filter UID is unknown.

pub fn iter(&self) -> impl Iterator<Item = &Filter>

Iterator over the filters.

pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut Filter>

Mutable iterator over the filters.

pub fn find_match(
    &mut self,
    timestamp: &SinceStart,
    alloc: &Alloc
) -> Option<Filter>

Searches for a filter that matches on the input allocation.

pub fn find_dead_match(&mut self, alloc: &Alloc) -> Option<Filter>

Searches for a filter that matches on the input allocation, for its death.

pub fn reset(&mut self)

Resets all the filters.

pub fn fold<T>(&self, init: T, fold: impl FnMut(T, Line) -> T) -> T

Fold over all the filter UIDs.

pub fn uid_map<T>(&self, default: T) -> BTMap<Line, T> where
    T: Clone + Debug + PartialEq, 

Generates a UID map.

impl Filters

Message handling

pub fn update(&mut self, msg: FiltersMsg) -> Res<(Msgs, bool)>

Applies a filter message.

pub fn revert(&self) -> Res<Msgs>

Sends all the filters to the client.

pub fn update_all(
    &mut self,
    everything: FilterSpec,
    filters: Vec<Filter>,
    catch_all: FilterSpec
) -> Res<Msgs>

Updates all the filters.

pub fn add_new(&mut self) -> Res<Msgs>

Adds a new filter.

pub fn add_new_sub(&mut self, uid: Filter) -> Res<Msgs>

Adds a new sub-filter.

pub fn filter_stats(&self) -> Res<AllFilterStats>

Extract filter statistics.

Trait Implementations

impl Clone for Filters

fn clone(&self) -> Filters

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Filters

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

Formats the value using the given formatter.