Struct PaceApp

pub struct PaceApp { /* private fields */ }

Pace Application

Implementations

impl PaceApp

pub fn config_path(&self) -> &Path

Get the config file path

pub fn set_config_path(&mut self, config_path: PathBuf)

Set the config file path

Trait Implementations

impl Application for PaceApp

type Cmd = EntryPoint

Entrypoint command for this application.

type Cfg = PaceConfig

Application configuration.

type Paths = StandardPaths

Paths to resources within the application.

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

Accessor for application configuration.

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

Borrow the application state immutably.

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 tracing_config(&self, command: &EntryPoint) -> Config

Get tracing configuration from command-line options

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

Load this application’s configuration and initialize its components.

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

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 shutdown(&self, shutdown: Shutdown) -> !

Shut down this application gracefully, exiting with success.

impl Debug for PaceApp

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

Formats the value using the given formatter.

impl Default for PaceApp

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.