Struct slint::SortModel

pub struct SortModel<M, F>(_)
where
    M: 'static + Model,
    F: SortHelper<<M as Model>::Data>
;
Expand description

Provides a sorted view of rows by another Model.

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

Generic parameters:

  • M the type of the wrapped Model.
  • F a type that provides an order to model rows. It is constrained by the internal trait SortHelper, which is used to sort the model in ascending order if the model data supports it, or by a given sort function.

Example

Here we have a VecModel holding SharedStrings. It is then sorted into a SortModel.

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

let sorted_model = SortModel::new(model, |lhs, rhs| lhs.to_lowercase().cmp(&rhs.to_lowercase()));

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

Alternatively you can use the shortcut ModelExt::sort_by.

let sorted_model = VecModel::from(vec![
    SharedString::from("Lorem"),
    SharedString::from("ipsum"),
    SharedString::from("dolor"),
]).sort_by(|lhs, rhs| lhs.to_lowercase().cmp(&rhs.to_lowercase()));

It is also possible to get a ascending sorted SortModel order for core::cmp::Ord type items.

let model = VecModel::from(vec![
    5,
    1,
    3,
]);

let sorted_model = SortModel::new_ascending(model);

assert_eq!(sorted_model.row_data(0).unwrap(), 1);
assert_eq!(sorted_model.row_data(1).unwrap(), 3);
assert_eq!(sorted_model.row_data(2).unwrap(), 5);

Alternatively you can use the shortcut ModelExt::sort.

let sorted_model = VecModel::from(vec![
    5,
    1,
    3,
]).sort();

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

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

let sorted_model = SortModel::new(model.clone(), |lhs, rhs| lhs.to_lowercase().cmp(&rhs.to_lowercase()));

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

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

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

Implementations§

Creates a new SortModel based on the given wrapped_model and sorted by sort_function. Alternativly you can use ModelExt::sort_by on your Model.

Creates a new SortModel based on the given wrapped_model and sorted in ascending order. Alternativly you can use ModelExt::sort on your Model.

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

Gets the row index of the underlying unsorted model for a given sorted row index.

Trait Implementations§

The model data: A model is a set of row and each row has this data
The amount of row in the model
Returns the data for a particular row. This function should be called with row < row_count(). Read more
Sets the data for a particular row. Read more
The implementation should return a reference to its ModelNotify field. Read more
Returns an iterator visiting all elements of the model.
Return something that can be downcast’ed (typically self) Read more

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Convenience function that calls ModelTracker::track_row_data_changes before returning Model::row_data. Read more
Returns a new Model where all elements are mapped by the function map_function. This is a shortcut for MapModel::new(). Read more
Returns a new Model where the elements are filtered by the function filter_function. This is a shortcut for FilterModel::new(). Read more
Returns a new Model where the elements are sorted ascending. This is a shortcut for SortModel::new_ascending(). Read more
Returns a new Model where the elements are sorted by the function sort_function. This is a shortcut for SortModel::new(). Read more
The alignment of pointer.
The type for initializers.
Initializes a with the given initializer. Read more
Dereferences the given pointer. Read more
Mutably dereferences the given pointer. Read more
Drops the object pointed to by the given pointer. Read more
Should always be Self
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.
Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more