Struct medusa::Handler

pub struct Handler { /* fields omitted */ }

Struct that defines a CLI option handler in a programmatic way.

Methods

impl Handler

pub fn new() -> Handler

Create a new empty Handler instance.

Example

use medusa::Handler;

// code ...

let mut handler: Handler = Handler::new();

pub fn get_actions(&self) -> Option<&HashMap<String, Variant>>

Get action handler list in form of HashMap from the current Handler instance.

Example

use medusa::{Handler, Variant};

use std::collections::HashMap;

let mut handler: Handler = Handler::new();
// code ...

if let Some(map) = handler.get_actions() {
    println!("Got some actions here!");
} else {
    println!("No actions defined!");
}

pub fn get_hints(&self) -> Option<&HashMap<String, String>>

Get action hint list in form of HashMap from the current Handler instance.

Example

use medusa::{Handler, Variant};

use std::collections::HashMap;

let mut handler: Handler = Handler::new();
// code ...

if let Some(map) = handler.get_hints() {
    println!("Got some hints here!");
} else {
    println!("No hints defined!");
}

pub fn add(&mut self, parameter: String, action: Variant, hint: String)

Add an action for CLI option handler. Note that you must also provide function hint for this option handler. This hint will be shown if arguments passed to this handler are invalid, or when the CLI is calling the --help option. This kind of hint usually a single line of String, but it is not restricted for multi-line String.

Example

use medusa::{Handler, Variant};

// code ...

fn show_help() {
    println!("This is help message!");
}

let mut handler: Handler = Handler::new();
handler.add(
    String::from("--help"),
    Variant::Plain(show_help),
    String::from("Show this help message.")
);