Struct Clot

pub struct Clot<T: Opts = Help> { /* private fields */ }

Command line option tree / subtree

Implementations

impl Clot

pub fn new(help: &'static str) -> Self

Create a new command line argument option tree.

• help text describing what the command does

Examples found in repository

examples/example.rs (line 4)

fn main() {
    Clot::new("Example program")
        .cmd("hello", hello)
        .cmd("add", add)
        .execute()
}

fn add() -> Clot<impl Opts> {
    Clot::new("Add two numbers").run(run_add)
}

fn hello() -> Clot<impl Opts> {
    Clot::new("Print hello world").run(run_hello)
}

impl<T: Opts> Clot<T>

pub fn run(self, f: fn(&dyn Opts)) -> Self

Add a callback to execute in place of help text when no subcomands are provided.

Examples found in repository

examples/example.rs (line 11)

fn add() -> Clot<impl Opts> {
    Clot::new("Add two numbers").run(run_add)
}

fn hello() -> Clot<impl Opts> {
    Clot::new("Print hello world").run(run_hello)
}

pub fn cmd<U: Opts, F: FnOnce() -> Clot<U>>( self, name: &'static str, f: F, ) -> Clot<Cmd<T, U, F>>

Create a new subcommand.

Panics

• If command name character is invalid (not lowercase ascii or -)
• If command name has more than two -
• If command name starts or ends with a -

Examples found in repository

examples/example.rs (line 5)

fn main() {
    Clot::new("Example program")
        .cmd("hello", hello)
        .cmd("add", add)
        .execute()
}

pub const fn field(self) -> Self

Create a new field on the subcommand

pub const fn param(self, _name: &'static str) -> Self

Create a new parameter on the command

pub const fn flag(self, flag: char) -> Self

Create a new flag on the command.

pub fn execute(self)

Validate the arguments and execute the selected subcommands.

Examples found in repository

examples/example.rs (line 7)

fn main() {
    Clot::new("Example program")
        .cmd("hello", hello)
        .cmd("add", add)
        .execute()
}