Struct kas::updatable::FilteredList

pub struct FilteredList<T, F> where
    T: ListData,
    F: Filter<<T as ListData>::Item>,  {
    pub data: T,
    // some fields omitted
}

Filter accessor over another accessor

This is an abstraction over a ListData, applying a filter to items when iterating and accessing.

When updating, the filter applies to the old value: if the old is included, it is replaced by the new, otherwise no replacement occurs.

Note: the key and item types are the same as those in the underlying list, thus one can also retrieve values from the underlying list directly.

Note: only Rc<FilteredList<T, F>> implements ListData; the Rc wrapper is required!

Warning: this implementation is O(n) where n = data.len() and not well optimised, thus is expected to be slow on large data lists.

Fields

data: T

Direct access to unfiltered data

If adjusting this, one should call FilteredList::refresh after.

Implementations

impl<T, F> FilteredList<T, F> where
    T: ListData,
    F: Filter<<T as ListData>::Item>, 

pub fn new(data: T, filter: F) -> FilteredList<T, F>

Construct and apply filter

pub fn refresh(&self) -> UpdateHandle

Refresh the view

Re-applies the filter (O(n) where n is the number of data elements). Calling this directly may be useful in case the data is modified.

An update should be triggered using the returned handle.

pub fn set_filter(&self, filter: F) -> UpdateHandle

Update and apply the filter

An update should be triggered using the returned handle. See FilteredList::refresh.

Trait Implementations

impl<T, F> Clone for FilteredList<T, F> where
    T: Clone + ListData,
    F: Clone + Filter<<T as ListData>::Item>,
    <T as ListData>::Key: Clone, 

pub fn clone(&self) -> FilteredList<T, F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, F> Debug for FilteredList<T, F> where
    T: Debug + ListData,
    F: Debug + Filter<<T as ListData>::Item>,
    <T as ListData>::Key: Debug, 

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

Formats the value using the given formatter.

impl<T, F> ListData for FilteredList<T, F> where
    T: 'static + ListData,
    F: Filter<<T as ListData>::Item>, 

type Key = <T as ListData>::Key

Key type

type Item = <T as ListData>::Item

Item type

pub fn len(&self) -> usize

Number of data items available

pub fn contains_key(&self, key: &<FilteredList<T, F> as ListData>::Key) -> bool

Check whether a key has data

pub fn get_cloned(
    &self,
    key: &<FilteredList<T, F> as ListData>::Key
) -> Option<<FilteredList<T, F> as ListData>::Item>

Get data by key (clone)

pub fn update(
    &self,
    key: &<FilteredList<T, F> as ListData>::Key,
    value: <FilteredList<T, F> as ListData>::Item
) -> Option<UpdateHandle>

Update data, if supported

pub fn iter_vec_from(
    &self,
    start: usize,
    limit: usize
) -> Vec<(<FilteredList<T, F> as ListData>::Key, <FilteredList<T, F> as ListData>::Item), Global>

Iterate over (key, value) pairs as a vec

fn iter_vec(&self, limit: usize) -> Vec<(Self::Key, Self::Item), Global>

Iterate over (key, value) pairs as a vec

impl<T, F> Updatable for FilteredList<T, F> where
    T: ListData,
    F: Filter<<T as ListData>::Item>, 

pub fn update_handle(&self) -> Option<UpdateHandle>

Get an update handle, if any is used to notify of updates

pub fn update_self(&self) -> Option<UpdateHandle>

Update self from an update handle

impl<K, M, T, F> UpdatableHandler<K, M> for FilteredList<T, F> where
    T: 'static + ListData + UpdatableHandler<K, M>,
    F: Filter<<T as ListData>::Item>, 

pub fn handle(&self, key: &K, msg: &M) -> Option<UpdateHandle>

Update data, if supported