Struct abscissa::application::CliApplication

pub struct CliApplication { /* fields omitted */ }

Abscissa CLI Application

Trait Implementations

impl Default for CliApplication

fn default() -> Self

Returns the "default value" for a type.

impl Debug for CliApplication

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

Formats the value using the given formatter.

impl Application for CliApplication

type Cmd = EntryPoint<CliCommand>

Application (sub)command which serves as the main entry point.

type Cfg = CliConfig

Configuration type used by this application.

type Paths = StandardPaths

Paths to application resources,

fn config(&self) -> &CliConfig

Accessor for application configuration.

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

Borrow the application state immutably.

fn state_mut(&mut self) -> &mut State<Self>

Borrow the application state mutably.

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>

Post-configuration lifecycle callback.

fn logging_config(&self, command: &EntryPoint<CliCommand>) -> Config

Get the logging configuration for this application.

fn run<I>(app_lock: &'static Lock<Self>, args: I) where
    I: IntoIterator<Item = String>, 

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

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

Load this application's configuration and initialize its components.

fn framework_components(
    &mut self,
    command: &Self::Cmd
) -> Result<Vec<Box<dyn Component<Self> + 'static>>, Error<FrameworkErrorKind>>

Initialize the framework's default set of components, potentially sourcing terminal and logging options from command line arguments.

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

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 version(&self) -> Version

Version 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 handle_signal(
    &mut self,
    signal: Signal
) -> Result<(), Error<FrameworkErrorKind>>

Handle a Unix signal received by this application

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

Shut down this application gracefully, exiting with success.