Struct zebrad::application::ZebradApp

pub struct ZebradApp {
    config: Option<ZebradConfig>,
    state: State<Self>,
}

Zebrad Application

Fields

config: Option<ZebradConfig>

Application configuration.

state: State<Self>

Application state.

Implementations

impl ZebradApp

fn outputs_are_ttys() -> bool

Are standard output and standard error both connected to ttys?

pub fn git_commit() -> Option<&'static str>

Returns the git commit for this build, if available.

Accuracy

If the user makes changes, but does not commit them, the git commit will not match the compiled source code.

Trait Implementations

impl Application for ZebradApp

type Cmd = EntryPoint

Entrypoint command for this application.

type Cfg = ZebradConfig

Application configuration.

type Paths = StandardPaths

Paths to resources within the application.

fn config(&self) -> &ZebradConfig

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 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 init(&mut self, command: &Self::Cmd) -> Result<(), FrameworkError>

Load this application’s configuration and initialize its components.

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

Shut down this application gracefully, exiting with success.

fn version(&self) -> Version

Version of this application.

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

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

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

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.

fn handle_signal(&mut self, signal: Signal) -> Result<(), FrameworkError>

Handle a Unix signal received by this application

impl Debug for ZebradApp

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

Formats the value using the given formatter.

impl Default for ZebradApp

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.