Struct cushy::PendingApp

pub struct PendingApp { /* private fields */ }

A Cushy application that has not started running yet.

Logging/Tracing in Cushy

This type is responsible for initializing Cushy’s built-in support for listening for tracing/log messages by installing a global tracing_subcriber Subscriber.

To enable logging/tracing support

Most ways of running a Cushy app will automatically intialize logging because at some point they call PendingApp::default(). The default behavior is to initialize logging.

When using PendingApp::new to provide a custom AppRuntime, support can be enabled using:

• with_tracing()
• initialize_tracing()

Overriding Cushy’s logging/tracing support

Cushy uses tracing_subscriber’s try_init() function to install the global subscriber. This function keeps the existing subscriber if one is already installed. This means to use your own Subscriber, install it before calling any Cushy code and your subscriber will be the one used.

Disabling tracing support

The tracing-output Cargo feature controls whether tracing is enabled. It is included in default-features, but can be omitted to disable tracing support.

Implementations

impl PendingApp

pub fn new<Runtime: AppRuntime>(runtime: Runtime) -> Self

Returns a new app using the provided runtime.

Unliked PendingApp::default(), this function does not initialize tracing support. See with_tracing()/initialize_tracing() to enable Cushy’s built-in trace handling.

pub fn with_on_unrecoverable_error<F>(self, on_error: F) -> Self

where F: FnMut(UnrecoverableError) + 'static,

Sets the error handler that is invoked when Cushy encounters an error that it cannot recover from.

Default Behavior

If native-dialogs is enabled, the default handler will display the error using a system-native message dialog. Otherwise, the default handler will panic.

Calling this function will override the default behavior with on_error.

pub fn with_tracing(self) -> Self

Installs a global tracing Subscriber and returns self.

pub fn initialize_tracing(&self)

Installs a global tracing Subscriber.

pub const fn cushy(&self) -> &Cushy

The shared resources this application utilizes.

pub fn on_startup<F, R>(&mut self, on_startup: F)

where F: FnOnce(&mut App) -> R + Send + 'static, R: StartupResult,

Executes on_startup once the application event loop has begun.

Some APIs are not available until after the application has started running. For example, App::monitors requires the event loop to have been started.

Trait Implementations

impl Application for PendingApp

fn cushy(&self) -> &Cushy

Returns the shared resources for the application.

fn as_app(&self) -> App

Returns this type as an App handle.

impl AsApplication<AppEvent<WindowCommand>> for PendingApp

fn as_application(&self) -> &dyn Application<AppEvent<WindowCommand>>

Returns this type’s application.

fn as_application_mut( &mut self, ) -> &mut dyn Application<AppEvent<WindowCommand>>

where AppEvent<WindowCommand>: Message,

Returns this type’s application.

impl Default for PendingApp

fn default() -> Self

Returns the “default value” for a type.

impl Run for PendingApp

fn run(self) -> Result

Runs the provided type, returning Ok(()) upon successful execution and program exit. Note that this function may not ever return on some platforms.