Struct slint::MapModel

pub struct MapModel<M, F> { /* private fields */ }
Expand description

Provides rows that are generated by a map function based on the rows of another Model

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

Generic parameters:

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

§Example

Here we have a VecModel holding rows of a custom type Name. It is then mapped into a MapModel of SharedStrings

#[derive(Clone)]
struct Name {
    first: String,
    last: String,
}

let model = VecModel::from(vec![
    Name { first: "Hans".to_string(), last: "Emil".to_string() },
    Name { first: "Max".to_string(), last: "Mustermann".to_string() },
    Name { first: "Roman".to_string(), last: "Tisch".to_string() },
]);

let mapped_model = MapModel::new(model, |n|
    slint::format!("{}, {}", n.last, n.first)
);

assert_eq!(mapped_model.row_data(0).unwrap(), SharedString::from("Emil, Hans"));
assert_eq!(mapped_model.row_data(1).unwrap(), SharedString::from("Mustermann, Max"));
assert_eq!(mapped_model.row_data(2).unwrap(), SharedString::from("Tisch, Roman"));

Alternatively you can use the shortcut ModelExt::map.

let mapped_model = VecModel::from(vec![
    Name { first: "Hans".to_string(), last: "Emil".to_string() },
    Name { first: "Max".to_string(), last: "Mustermann".to_string() },
    Name { first: "Roman".to_string(), last: "Tisch".to_string() },
])
.map(|n| slint::format!("{}, {}", n.last, n.first));

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

let model = Rc::new(VecModel::from(vec![
    Name { first: "Hans".to_string(), last: "Emil".to_string() },
    Name { first: "Max".to_string(), last: "Mustermann".to_string() },
    Name { first: "Roman".to_string(), last: "Tisch".to_string() },
]));

let mapped_model = MapModel::new(model.clone(), |n|
    slint::format!("{}, {}", n.last, n.first)
);

model.set_row_data(1, Name { first: "Minnie".to_string(), last: "Musterfrau".to_string() });

assert_eq!(mapped_model.row_data(0).unwrap(), SharedString::from("Emil, Hans"));
assert_eq!(mapped_model.row_data(1).unwrap(), SharedString::from("Musterfrau, Minnie"));
assert_eq!(mapped_model.row_data(2).unwrap(), SharedString::from("Tisch, Roman"));

Implementations§

§

impl<M, F, T, U> MapModel<M, F>
where M: 'static + Model<Data = T>, F: 'static + Fn(T) -> U,

pub fn new(wrapped_model: M, map_function: F) -> MapModel<M, F>

Creates a new MapModel based on the given wrapped_model and map_function. Alternatively you can use ModelExt::map on your Model.

pub fn source_model(&self) -> &M

Returns a reference to the inner model

Trait Implementations§

§

impl<M, F, T, U> Model for MapModel<M, F>
where M: 'static + Model<Data = T>, F: 'static + Fn(T) -> U,

§

type Data = U

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

fn row_count(&self) -> usize

The amount of row in the model
§

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

Returns the data for a particular row. This function should be called with row < row_count(). 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 set_row_data(&self, _row: usize, _data: Self::Data)

Sets the data for a particular row. 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 MapModel<M, F>
where F: Freeze, M: Freeze,

§

impl<M, F> RefUnwindSafe for MapModel<M, F>

§

impl<M, F> Send for MapModel<M, F>
where F: Send, M: Send,

§

impl<M, F> Sync for MapModel<M, F>
where F: Sync, M: Sync,

§

impl<M, F> Unpin for MapModel<M, F>
where F: Unpin, M: Unpin,

§

impl<M, F> UnwindSafe for MapModel<M, F>
where F: UnwindSafe, M: UnwindSafe,

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

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
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.

§

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