Struct relm4::prelude::RelmApp

source ·
pub struct RelmApp { /* private fields */ }
Expand description

An app that runs the main application.

Implementations§

source§

impl RelmApp

source

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.

source

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

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

source

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.

source

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.

source

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.

source

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.

Trait Implementations§

source§

impl Debug for RelmApp

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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<C> AsyncPosition<()> for C

source§

fn position(_index: usize)

Returns the position. Read more
source§

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

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

const: unstable · source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

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

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>,

const: unstable · 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.

source§

impl<C> Position<()> for C

source§

fn position(&self, _index: usize)

Returns the position. 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.
const: unstable · 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.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more