Struct relm4::prelude::RelmApp

pub struct RelmApp { /* private fields */ }

An app that runs the main application.

Implementations

impl RelmApp

pub fn new(app_id: &str) -> Self

Create a new Relm4 application.

This function will create a new gtk::Application object if necessary.

If the libadwaita feature is enabled, then the created gtk::Application will be an instance of adw::Application. This can be overridden by passing your own application object to RelmApp::with_app.

pub fn with_app(app: impl IsA<Application>) -> Self

Create a Relm4 application with a provided gtk::Application.

pub fn run<C>(self, payload: C::Init)where
    C: Component,
    C::Root: IsA<Window> + WidgetExt,

Runs the application, returns once the application is closed.

Unlike [gtk::prelude::ApplicationExtManual::run], this function does not handle command-line arguments. To pass arguments to GTK, use RelmApp::run_with_args.

pub fn run_with_args<C, S>(self, payload: C::Init, args: &[S])where
    C: Component,
    C::Root: IsA<Window> + WidgetExt,
    S: AsRef<str>,

Runs the application with the provided command-line arguments, returns once the application is closed.

Examples found in repository

src/app.rs (line 49)

    pub fn run<C>(self, payload: C::Init)
    where
        C: Component,
        C::Root: IsA<gtk::Window> + WidgetExt,
    {
        self.run_with_args::<C, &str>(payload, &[]);
    }

pub fn run_async<C>(self, payload: C::Init)where
    C: AsyncComponent,
    C::Root: IsA<Window> + WidgetExt,

Runs the application, returns once the application is closed.

Unlike [gtk::prelude::ApplicationExtManual::run], this function does not handle command-line arguments. To pass arguments to GTK, use RelmApp::run_with_args.

pub fn run_async_with_args<C, S>(self, payload: C::Init, args: &[S])where
    C: AsyncComponent,
    C::Root: IsA<Window> + WidgetExt,
    S: AsRef<str>,

Runs the application with the provided command-line arguments, returns once the application is closed.

Examples found in repository

src/app.rs (line 104)

    pub fn run_async<C>(self, payload: C::Init)
    where
        C: AsyncComponent,
        C::Root: IsA<gtk::Window> + WidgetExt,
    {
        self.run_async_with_args::<C, &str>(payload, &[]);
    }

Trait Implementations

impl Debug for RelmApp

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

Formats the value using the given formatter.