Struct ExitPlugin 

pub struct ExitPlugin { /* private fields */ }

Standalone builtin providing only the exit command.

Use this instead of [SystemPlugin][crate::builtin::system::SystemPlugin] when an application wants exit without also registering help and version.

Shutdown callback

Same mechanism as SystemPlugin: the callback runs before the process exits. The default callback calls std::process::exit(0) directly.

use dynamic_cli::plugin::ExitPlugin;

let builtin = ExitPlugin::new()
    .with_exit_fn(|| {
        eprintln!("Goodbye.");
        std::process::exit(0);
    });

YAML config

commands:
  - name: exit
    implementation: system_exit
    description: "Exit the application"
    aliases: ["quit", "q"]
    required: false
    arguments: []
    options: []

Example

use dynamic_cli::plugin::{ExitPlugin, Plugin};

let builtin = ExitPlugin::new();
assert_eq!(builtin.name(), "exit");

let handlers = builtin.handlers();
assert_eq!(handlers.len(), 1);
assert_eq!(handlers[0].0, "system_exit");

Implementations

impl ExitPlugin

pub fn new() -> Self

Create a new ExitPlugin with the default shutdown behaviour.

Example

use dynamic_cli::plugin::{ExitPlugin, Plugin};

let builtin = ExitPlugin::new();
assert_eq!(builtin.name(), "exit");

pub fn with_exit_fn<F>(self, f: F) -> Self

where F: Fn() + Send + Sync + 'static,

Supply a custom shutdown callback for system_exit.

The callback must be Fn() + Send + Sync + 'static.

Example

use dynamic_cli::plugin::ExitPlugin;

let builtin = ExitPlugin::new()
    .with_exit_fn(|| {
        eprintln!("Saving session…");
        std::process::exit(0);
    });

Trait Implementations

impl Default for ExitPlugin

fn default() -> Self

Returns the “default value” for a type.

impl Plugin for ExitPlugin

fn name(&self) -> &str

Short identifier for this plugin (e.g. "system", "greet").

fn version(&self) -> &str

Semantic version string (e.g. "1.0.0").

fn description(&self) -> &str

Human-readable description of what this plugin provides.

fn handlers(&self) -> Vec<(String, Box<dyn CommandHandler>)>

Returns the handlers this plugin contributes.