Skip to main content

ExitPlugin

Struct ExitPlugin 

Source
pub struct ExitPlugin { /* private fields */ }
Expand description

Standalone builtin providing only the exit command.

Use this instead of 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§

Source§

impl ExitPlugin

Source

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");
Source

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§

Source§

impl Default for ExitPlugin

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Plugin for ExitPlugin

Source§

fn name(&self) -> &str

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

fn version(&self) -> &str

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

fn description(&self) -> &str

Human-readable description of what this plugin provides.
Source§

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

Returns the handlers this plugin contributes. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.