Struct seahorse::Command

pub struct Command {
    pub name: String,
    pub usage: String,
    pub action: Action,
    pub flags: Option<Vec<Flag>>,
}

Application command type

Fields

name: String

Command name

usage: String

Command usage

action: Action

Command action

flags: Option<Vec<Flag>>

Action flags

Methods

impl Command

pub fn new() -> Self

Create new instance of Command

Example

use seahorse::Command;

let command = Command::new();

pub fn name<T: Into<String>>(self, name: T) -> Self

Set name of the command

Example

use seahorse::Command;

let command = Command::new();
command.name("cmd");

pub fn usage<T: Into<String>>(self, usage: T) -> Self

Set usage of the command

Example

use seahorse::Command;

let command = Command::new();
command.usage("cli cmd [arg]");

pub fn action(self, action: Action) -> Self

Set action of the command

Example

use seahorse::{Command, Context, Action};

let command = Command::new();
let action: Action = |c: &Context| println!("{:?}", c.args);
command.action(action);

pub fn flags(self, flags: Vec<Flag>) -> Self

Set flags of the command

Example

use seahorse::{Command, Flag, FlagType};

let command = Command::new();
command.flags(vec![
    Flag::new("bool", "cli cmd [arg] --bool", FlagType::Bool),
    Flag::new("string", "cli cmd [arg] --string [string]", FlagType::String)
]);

pub fn run(&self, v: Vec<String>)

Run command Call this function only from App

Trait Implementations

impl Default for Command

fn default() -> Self

Returns the "default value" for a type.