Struct slint::ModelRc

pub struct ModelRc<T>(/* private fields */);
Expand description

ModelRc is a type wrapper for a reference counted implementation of the Model trait.

Models are used to represent sequences of the same data type. In .slint code those are represented using the [T] array syntax and typically used in for expressions, array properties, and array struct fields.

For example, a property <[string]> foo will be of type ModelRc<SharedString> and, behind the scenes, wraps a Rc<dyn Model<Data = SharedString>>.

An array struct field will also be of type ModelRc:

export struct AddressBook {
    names: [string]
}

When accessing AddressBook from Rust, the names field will be of type ModelRc<SharedString>.

There are several ways of constructing a ModelRc in Rust:

  • An empty ModelRc can be constructed with ModelRc::default().
  • A ModelRc can be constructed from a slice or an array using the From trait. This allocates a VecModel.
  • Use ModelRc::new() to construct a ModelRc from a type that implements the Model trait, such as VecModel or your own implementation.
  • If you have your model already in an Rc, then you can use the From trait to convert from Rc<dyn Model<Data = T>> to ModelRc.

Example

use slint::{slint, SharedString, ModelRc, Model, VecModel};
use std::rc::Rc;
slint!{
    import { Button } from "std-widgets.slint";
    export component Example {
        callback add_item <=> btn.clicked;
        in property <[string]> the_model;
        HorizontalLayout {
            for it in the_model : Text { text: it; }
            btn := Button { text: "Add"; }
        }
    }
}
let ui = Example::new().unwrap();
// Create a VecModel and put it in an Rc.
let the_model : Rc<VecModel<SharedString>> =
        Rc::new(VecModel::from(vec!["Hello".into(), "World".into()]));
// Convert it to a ModelRc.
let the_model_rc = ModelRc::from(the_model.clone());
// Pass the model to the ui: The generated set_the_model setter from the
// the_model property takes a ModelRc.
ui.set_the_model(the_model_rc);

// We have kept a strong reference to the_model, to modify it in a callback.
ui.on_add_item(move || {
    // Use VecModel API: VecModel uses the Model notification mechanism to let Slint
    // know it needs to refresh the UI.
    the_model.push("SomeValue".into());
});

// Alternative: we can re-use a getter.
let ui_weak = ui.as_weak();
ui.on_add_item(move || {
    let ui = ui_weak.unwrap();
    let the_model_rc = ui.get_the_model();
    let the_model = the_model_rc.as_any().downcast_ref::<VecModel<SharedString>>()
        .expect("We know we set a VecModel earlier");
    the_model.push("An Item".into());
});

Implementations§

§

impl<T> ModelRc<T>

pub fn new(model: impl Model<Data = T> + 'static) -> ModelRc<T>

Trait Implementations§

§

impl<T> Clone for ModelRc<T>

§

fn clone(&self) -> ModelRc<T>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
§

impl<T> Debug for ModelRc<T>

§

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

Formats the value using the given formatter. Read more
§

impl<T> Default for ModelRc<T>

§

fn default() -> ModelRc<T>

Construct an empty model

§

impl<T> From<&[T]> for ModelRc<T>where T: Clone + 'static,

§

fn from(slice: &[T]) -> ModelRc<T>

Converts to this type from the input type.
§

impl<T, const N: usize> From<[T; N]> for ModelRc<T>where T: Clone + 'static,

§

fn from(array: [T; N]) -> ModelRc<T>

Converts to this type from the input type.
§

impl<T, M> From<Rc<M>> for ModelRc<T>where M: Model<Data = T> + 'static,

§

fn from(model: Rc<M>) -> ModelRc<T>

Converts to this type from the input type.
§

impl<T> From<Rc<dyn Model<Data = T>>> for ModelRc<T>

§

fn from(model: Rc<dyn Model<Data = T>>) -> ModelRc<T>

Converts to this type from the input type.
§

impl<T> Model for ModelRc<T>

§

type Data = T

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<<ModelRc<T> as Model>::Data>

Returns the data for a particular row. This function should be called with row < row_count(). Read more
§

fn set_row_data(&self, row: usize, data: <ModelRc<T> 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.
§

impl<T> PartialEq for ModelRc<T>

§

fn eq(&self, other: &ModelRc<T>) -> bool

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
§

impl<T> TryInto<Rc<dyn Model<Data = T>>> for ModelRc<T>

§

type Error = ()

The type returned in the event of a conversion error.
§

fn try_into( self ) -> Result<Rc<dyn Model<Data = T>>, <ModelRc<T> as TryInto<Rc<dyn Model<Data = T>>>>::Error>

Performs the conversion.

Auto Trait Implementations§

§

impl<T> !RefUnwindSafe for ModelRc<T>

§

impl<T> !Send for ModelRc<T>

§

impl<T> !Sync for ModelRc<T>

§

impl<T> Unpin for ModelRc<T>

§

impl<T> !UnwindSafe for ModelRc<T>

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> Downcast for Twhere 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 Twhere 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 Twhere 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> NoneValue for Twhere T: Default,

§

type NoneType = T

§

fn null_value() -> T

The none-equivalent value.
§

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<R, P> ReadPrimitive<R> for Pwhere R: Read + ReadEndian<P>, P: Default,

source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere 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 Twhere 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 Twhere 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