Struct relm4::loading_widgets::LoadingWidgets

pub struct LoadingWidgets { /* private fields */ }

A type that stores widget containers and their child widgets and removes all children automatically when dropped.

This mechanism is used by async components and factories to show widgets while the async init function isn’t completed. Once the actual widgets are initialized, the temporary loading widgets can be removed again, which is simply done with this type.

Implementations

impl LoadingWidgets

pub fn new<C, W>(container: &C, child: W) -> Selfwhere C: RelmRemoveExt + Clone + 'static, W: AsRef<C::Child>, C::Child: Clone + AsRef<C::Child>,

Create new LoadingWidgets with one child.

Examples found in repository

relm4/examples/simple_async.rs (line 70)

    fn init_loading_widgets(root: &mut Self::Root) -> Option<LoadingWidgets> {
        view! {
            #[local_ref]
            root {
                set_title: Some("Simple app"),
                set_default_size: (300, 100),

                // This will be removed automatically by
                // LoadingWidgets when the full view has loaded
                #[name(spinner)]
                gtk::Spinner {
                    start: (),
                    set_halign: gtk::Align::Center,
                }
            }
        }
        Some(LoadingWidgets::new(root, spinner))
    }

relm4/examples/factory_async.rs (line 109)

    fn init_loading_widgets(root: &mut Self::Root) -> Option<LoadingWidgets> {
        view! {
            #[local_ref]
            root {
                set_orientation: gtk::Orientation::Horizontal,
                set_spacing: 10,

                #[name(spinner)]
                gtk::Spinner {
                    start: (),
                    set_hexpand: true,
                    set_halign: gtk::Align::Center,
                    // Reserve vertical space
                    set_height_request: 34,
                }
            }
        }
        Some(LoadingWidgets::new(root, spinner))
    }

pub fn with_children<C, W>(container: &C, children: &[W]) -> Selfwhere C: RelmRemoveExt + Clone + 'static, W: AsRef<C::Child>, C::Child: Clone + AsRef<C::Child>,

Create new LoadingWidgets with multiple children.

pub fn push<C, W>(&mut self, container: &C, child: W)where C: RelmRemoveExt + Clone + 'static, W: AsRef<C::Child>, C::Child: Clone + AsRef<C::Child>,

Add another child to the temporary loading widgets.

pub fn add_many<C, W>(&mut self, container: &C, children: &[W])where C: RelmRemoveExt + Clone + 'static, W: AsRef<C::Child>, C::Child: Clone + AsRef<C::Child>,

Add many children to the temporary loading widgets.

Trait Implementations

impl Debug for LoadingWidgets

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

Formats the value using the given formatter.

impl Drop for LoadingWidgets

fn drop(&mut self)

Executes the destructor for this type.