Struct RusticApp

pub struct RusticApp {
    config: CfgCell<RusticConfig>,
    state: State<Self>,
}

Rustic Application

Fields

config: CfgCell<RusticConfig>

Application configuration.

state: State<Self>

Application state.

Trait Implementations

impl Application for RusticApp

type Cmd = EntryPoint

Entrypoint command for this application.

type Cfg = RusticConfig

Application configuration.

type Paths = StandardPaths

Paths to resources within the application.

fn config(&self) -> Reader<RusticConfig>

Accessor for application configuration.

fn state(&self) -> &State<Self>

Borrow the application state immutably.

fn framework_components( &mut self, command: &Self::Cmd, ) -> Result<Vec<Box<dyn Component<Self>>>, FrameworkError>

Returns the framework components used by this application.

fn register_components( &mut self, command: &Self::Cmd, ) -> Result<(), FrameworkError>

Register all components used by this application.

If you would like to add additional components to your application beyond the default ones provided by the framework, this is the place to do so.

fn after_config(&mut self, config: Self::Cfg) -> Result<(), FrameworkError>

Post-configuration lifecycle callback.

Called regardless of whether config is loaded to indicate this is the time in app lifecycle when configuration would be loaded if possible.

fn shutdown(&self, shutdown: Shutdown) -> !

Shut down this application gracefully

fn shutdown_with_exitcode(&self, shutdown: Shutdown, exit_code: i32) -> !

Shut down this application gracefully, exiting with given exit code.

fn run<I, T>(app_cell: &'static AppCell<Self>, args: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Run application with the given command-line arguments and running the appropriate Command type.

fn init(&mut self, command: &Self::Cmd) -> Result<(), FrameworkError>

Load this application’s configuration and initialize its components.

fn load_config(&mut self, path: &Path) -> Result<Self::Cfg, FrameworkError>

Load configuration from the given path.

fn name(&self) -> &'static str

Name of this application as a string.

fn description(&self) -> &'static str

Description of this application.

fn authors(&self) -> Vec<String>

Authors of this application.

fn term_colors(&self, command: &Self::Cmd) -> ColorChoice

Color configuration for this application.

fn tracing_config(&self, command: &Self::Cmd) -> Config

Get the tracing configuration for this application.

impl Debug for RusticApp

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

Formats the value using the given formatter.

impl Default for RusticApp

Initialize a new application instance.

By default no configuration is loaded, and the framework state is initialized to a default, empty state (no components, threads, etc).

fn default() -> Self

Returns the “default value” for a type.