Struct dptree::description::InterestSet

pub struct InterestSet<K, S = RandomState> {
    pub observed: HashSet<K, S>,
    pub filtered: HashSet<K, S>,
}

Description for a handler that describes what event kinds are interesting to the handler.

This can be useful if you can filter events before they are passed to dptree. In this case you should keep updates that are in the observed set.

Fields

observed: HashSet<K, S>

Event kinds that are of interested for a given handler.

I.e. the ones that can cause meaningful side-effects.

filtered: HashSet<K, S>

Event kinds that can be observed by handlers chained to this one.

Implementations

impl<K: EventKind<S>, S> InterestSet<K, S>

pub fn new_filter(filtered: HashSet<K, S>) -> Self

Constructs an InterestSet for a filter that allows to pass through it only updates with kinds in the filtered set.

Note that the filter should not have observable side-effects, for example:

use dptree::{description::{InterestSet, EventKind}, filter_with_description};
use maplit::hashset;

filter_with_description(InterestSet::new_filter(hashset! {}), || {
    println!("Filter called!"); // <-- bad

    false
});

filter_with_description(InterestSet::new_filter(hashset! {}), |db: Db| {
    let pass = db.fetch_enabled(); // <-- fine

    pass
});

Trait Implementations

impl<K: Clone, S: Clone> Clone for InterestSet<K, S>

fn clone(&self) -> InterestSet<K, S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K: Debug, S: Debug> Debug for InterestSet<K, S>

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

Formats the value using the given formatter.

impl<T, S> HandlerDescription for InterestSet<T, S> where
    T: EventKind<S> + Eq + Hash + Clone,
    S: BuildHasher + Clone,
    T: Send + Sync + 'static,
    S: Send + Sync + 'static, 

fn entry() -> Self

Description for entry.

fn user_defined() -> Self

Description for a user-defined handler that can do practically everything.

fn endpoint() -> Self

Description for endpoint.

fn merge_chain(&self, other: &Self) -> Self

Merge descriptions to get a description for a chain handler.

fn merge_branch(&self, other: &Self) -> Self

Merge descriptions to get a description for a branch handler.

fn map() -> Self

Description for map.

fn map_async() -> Self

Description for map_async.

fn filter() -> Self

Description for filter.

fn filter_async() -> Self

Description for filter_async.

fn filter_map() -> Self

Description for filter_map.

fn filter_map_async() -> Self

Description for filter_map_async.

fn inspect() -> Self

Description for inspect.

fn inspect_async() -> Self

Description for inspect_async.

impl<K: Hash + Eq, S: BuildHasher> PartialEq<InterestSet<K, S>> for InterestSet<K, S>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<K: Hash + Eq, S: BuildHasher> Eq for InterestSet<K, S>