Trait zebrad::prelude::Application
pub trait Application:
Sized
+ Default
+ 'static {
type Cmd: Command + Configurable<Self::Cfg> + Parser;
type Cfg: Config;
type Paths: Default + ExePath + RootPath;
Show 14 methods
// Required methods
fn config(&self) -> Arc<Self::Cfg>;
fn state(&self) -> &State<Self>;
fn register_components(
&mut self,
command: &Self::Cmd,
) -> Result<(), FrameworkError>;
fn after_config(&mut self, config: Self::Cfg) -> Result<(), FrameworkError>;
// Provided methods
fn run<I, T>(app_cell: &'static AppCell<Self>, args: I)
where I: IntoIterator<Item = T>,
T: Into<OsString> + Clone { ... }
fn init(&mut self, command: &Self::Cmd) -> Result<(), FrameworkError> { ... }
fn framework_components(
&mut self,
command: &Self::Cmd,
) -> Result<Vec<Box<dyn Component<Self>>>, FrameworkError> { ... }
fn load_config(&mut self, path: &Path) -> Result<Self::Cfg, FrameworkError> { ... }
fn name(&self) -> &'static str { ... }
fn description(&self) -> &'static str { ... }
fn authors(&self) -> Vec<String> { ... }
fn term_colors(&self, command: &Self::Cmd) -> ColorChoice { ... }
fn tracing_config(&self, command: &Self::Cmd) -> Config { ... }
fn shutdown(&self, shutdown: Shutdown) -> ! { ... }
}
Expand description
Commonly used Abscissa traits Application types implementing this trait own global application state, including configuration and arbitrary other values stored within application components.
Application lifecycle is handled by a set of components owned by types implementing this trait. It also ties together the following:
Cmd
: application entrypointConfig
: application configurationPaths
: paths to various resources within the application
Required Associated Types§
type Cmd: Command + Configurable<Self::Cfg> + Parser
type Cmd: Command + Configurable<Self::Cfg> + Parser
Application (sub)command which serves as the main entry point.
type Cfg: Config
type Cfg: Config
Configuration type used by this application.
Required Methods§
fn state(&self) -> &State<Self>
fn state(&self) -> &State<Self>
Borrow the application state.
fn register_components(
&mut self,
command: &Self::Cmd,
) -> Result<(), FrameworkError>
fn register_components( &mut self, command: &Self::Cmd, ) -> Result<(), FrameworkError>
Register all components used by this application.
fn after_config(&mut self, config: Self::Cfg) -> Result<(), FrameworkError>
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.
This method is responsible for invoking the after_config
handlers on
all components in the registry. This is presently done in the standard
application template, but is not otherwise handled directly by the
framework (as ownership precludes it).
Provided Methods§
fn run<I, T>(app_cell: &'static AppCell<Self>, args: I)
fn run<I, T>(app_cell: &'static AppCell<Self>, args: I)
Run application with the given command-line arguments and running the
appropriate Command
type.
fn init(&mut self, command: &Self::Cmd) -> Result<(), FrameworkError>
fn init(&mut self, command: &Self::Cmd) -> Result<(), FrameworkError>
Load this application’s configuration and initialize its components.
fn framework_components(
&mut self,
command: &Self::Cmd,
) -> Result<Vec<Box<dyn Component<Self>>>, FrameworkError>
fn framework_components( &mut self, command: &Self::Cmd, ) -> Result<Vec<Box<dyn Component<Self>>>, FrameworkError>
Initialize the framework’s default set of components, potentially sourcing terminal and tracing options from command line arguments.
fn load_config(&mut self, path: &Path) -> Result<Self::Cfg, FrameworkError>
fn load_config(&mut self, path: &Path) -> Result<Self::Cfg, FrameworkError>
Load configuration from the given path.
Returns an error if the configuration could not be loaded.
fn description(&self) -> &'static str
fn description(&self) -> &'static str
Description of this application.
Authors of this application.
fn term_colors(&self, command: &Self::Cmd) -> ColorChoice
fn term_colors(&self, command: &Self::Cmd) -> ColorChoice
Color configuration for this application.
fn tracing_config(&self, command: &Self::Cmd) -> Config
fn tracing_config(&self, command: &Self::Cmd) -> Config
Get the tracing configuration for this application.