Struct slint::FilterModel

pub struct FilterModel<M, F>(/* private fields */)
where
    M: Model + 'static,
    F: Fn(&<M as Model>::Data) -> bool + 'static;
Expand description

Provides a filtered subset of rows by another Model.

When the other Model is updated, the FilterModel is updated accordingly.

Generic parameters:

  • M the type of the wrapped Model.
  • F the filter function.

§Example

Here we have a VecModel holding crate::SharedStrings. It is then filtered into a FilterModel.

let model = VecModel::from(vec![
    SharedString::from("Lorem"),
    SharedString::from("ipsum"),
    SharedString::from("dolor"),
]);

let filtered_model = FilterModel::new(model, |s| s.contains('o'));

assert_eq!(filtered_model.row_data(0).unwrap(), SharedString::from("Lorem"));
assert_eq!(filtered_model.row_data(1).unwrap(), SharedString::from("dolor"));

Alternatively you can use the shortcut ModelExt::filter.

let filtered_model = VecModel::from(vec![
    SharedString::from("Lorem"),
    SharedString::from("ipsum"),
    SharedString::from("dolor"),
]).filter(|s| s.contains('o'));

If you want to modify the underlying VecModel you can give it a Rc of the FilterModel:

let model = Rc::new(VecModel::from(vec![
    SharedString::from("Lorem"),
    SharedString::from("ipsum"),
    SharedString::from("dolor"),
]));

let filtered_model = FilterModel::new(model.clone(), |s| s.contains('o'));

assert_eq!(filtered_model.row_data(0).unwrap(), SharedString::from("Lorem"));
assert_eq!(filtered_model.row_data(1).unwrap(), SharedString::from("dolor"));

model.set_row_data(1, SharedString::from("opsom"));

assert_eq!(filtered_model.row_data(0).unwrap(), SharedString::from("Lorem"));
assert_eq!(filtered_model.row_data(1).unwrap(), SharedString::from("opsom"));
assert_eq!(filtered_model.row_data(2).unwrap(), SharedString::from("dolor"));

Implementations§

§

impl<M, F> FilterModel<M, F>
where M: Model + 'static, F: Fn(&<M as Model>::Data) -> bool + 'static,

pub fn new(wrapped_model: M, filter_function: F) -> FilterModel<M, F>

Creates a new FilterModel based on the given wrapped_model and filtered by filter_function. Alternatively you can use ModelExt::filter on your Model.

pub fn reset(&self)

Manually reapply the filter. You need to run this e.g. if the filtering function depends on mutable state and it has changed.

pub fn unfiltered_row(&self, filtered_row: usize) -> usize

Gets the row index of the underlying unfiltered model for a given filtered row index.

pub fn source_model(&self) -> &M

Returns a reference to the inner model

Trait Implementations§

§

impl<M, F> Model for FilterModel<M, F>
where M: Model + 'static, F: Fn(&<M as Model>::Data) -> bool + 'static,

§

type Data = <M as Model>::Data

The model data: A model is a set of rows and each row has this data
§

fn row_count(&self) -> usize

The number of rows in the model
§

fn row_data(&self, row: usize) -> Option<<FilterModel<M, F> as Model>::Data>

Returns the data for a particular row. Read more
§

fn set_row_data(&self, row: usize, data: <FilterModel<M, F> as Model>::Data)

Sets the data for a particular row. Read more
§

fn model_tracker(&self) -> &dyn ModelTracker

The implementation should return a reference to its ModelNotify field. Read more
§

fn as_any(&self) -> &(dyn Any + 'static)

Return something that can be downcast’ed (typically self) Read more
§

fn iter(&self) -> ModelIterator<'_, Self::Data>
where Self: Sized,

Returns an iterator visiting all elements of the model.

Auto Trait Implementations§

§

impl<M, F> Freeze for FilterModel<M, F>

§

impl<M, F> !RefUnwindSafe for FilterModel<M, F>

§

impl<M, F> !Send for FilterModel<M, F>

§

impl<M, F> !Sync for FilterModel<M, F>

§

impl<M, F> Unpin for FilterModel<M, F>

§

impl<M, F> !UnwindSafe for FilterModel<M, F>

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
§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> ModelExt for T
where T: Model,

§

fn row_data_tracked(&self, row: usize) -> Option<Self::Data>

Convenience function that calls ModelTracker::track_row_data_changes before returning Model::row_data. Read more
§

fn map<F, U>(self, map_function: F) -> MapModel<Self, F>
where Self: Sized + 'static, F: Fn(Self::Data) -> U + 'static,

Returns a new Model where all elements are mapped by the function map_function. This is a shortcut for MapModel::new().
§

fn filter<F>(self, filter_function: F) -> FilterModel<Self, F>
where Self: Sized + 'static, F: Fn(&Self::Data) -> bool + 'static,

Returns a new Model where the elements are filtered by the function filter_function. This is a shortcut for FilterModel::new().
§

fn sort(self) -> SortModel<Self, AscendingSortHelper>
where Self: Sized + 'static, Self::Data: Ord,

Returns a new Model where the elements are sorted ascending. This is a shortcut for SortModel::new_ascending().
§

fn sort_by<F>(self, sort_function: F) -> SortModel<Self, F>
where Self: Sized + 'static, F: FnMut(&Self::Data, &Self::Data) -> Ordering + 'static,

Returns a new Model where the elements are sorted by the function sort_function. This is a shortcut for SortModel::new().
§

fn reverse(self) -> ReverseModel<Self>
where Self: Sized + 'static,

Returns a new Model where the elements are reversed. This is a shortcut for ReverseModel::new().
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

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

§

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more