Struct tmkms::application::KmsApplication

pub struct KmsApplication { /* fields omitted */ }

The tmkms application

Trait Implementations

impl Default for KmsApplication

fn default() -> Self

Returns the "default value" for a type.

impl Debug for KmsApplication

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

Formats the value using the given formatter.

impl Application for KmsApplication

type Cmd = KmsCommand

Entrypoint command for this application.

type Cfg = KmsConfig

Application configuration.

type Paths = StandardPaths

Paths to resources within the application.

fn config(&self) -> Option<&KmsConfig>

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.

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: Option<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 logging_config(&self, command: &KmsCommand) -> Config

Get logging configuration from command-line options

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,
    command: &Self::Cmd
) -> Result<Self::Cfg, Error<FrameworkErrorKind>>

Load configuration from command's config_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.