Struct seahorse::App

pub struct App {
    pub name: String,
    pub author: Option<String>,
    pub description: Option<String>,
    pub usage: Option<String>,
    pub version: Option<String>,
    pub commands: Option<Vec<Command>>,
    pub action: Option<Action>,
    pub flags: Option<Vec<Flag>>,
}

Multiple action application entry point

Fields

name: String

Application name

author: Option<String>

Application author

description: Option<String>

Application description

usage: Option<String>

Application usage

version: Option<String>

Application version

commands: Option<Vec<Command>>

Application commands

action: Option<Action>

Application action

flags: Option<Vec<Flag>>

Application flags

Implementations

impl App

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

Create new instance of App

Example

use seahorse::App;

let app = App::new("cli");

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

Set author of the app

Example

use seahorse::App;

let app = App::new("cli")
    .author(env!("CARGO_PKG_AUTHORS"));

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

Set description of the app

Example

use seahorse::App;

let app = App::new("cli")
    .description(env!("CARGO_PKG_DESCRIPTION"));

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

Set usage of the app

Example

use seahorse::App;

let app = App::new("cli");
app.usage("cli [command] [arg]");

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

Set version of the app

Example

use seahorse::App;

let app = App::new("cli");
app.version(env!("CARGO_PKG_VERSION"));

pub fn command(self, command: Command) -> Self

Set command of the app

Example

use seahorse::{App, Command};

let command = Command::new("hello")
    .usage("cli hello [arg]")
    .action(|c| println!("{:?}", c.args));

let app = App::new("cli")
    .command(command);

Panics

You cannot set a command named as same as registered ones.

use seahorse::{App, Command};

let command1 = Command::new("hello")
    .usage("cli hello [arg]")
    .action(|c| println!("{:?}", c.args));

let command2 = Command::new("hello")
    .usage("cli hello [arg]")
    .action(|c| println!("{:?}", c.args));

let app = App::new("cli")
    .command(command1)
    .command(command2);

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

Set action of the app

Example

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

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

pub fn flag(self, flag: Flag) -> Self

Set flag of the app

Example

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

let app = App::new("cli")
    .flag(Flag::new("bool", FlagType::Bool))
    .flag(Flag::new("int", FlagType::Int));

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

Run app

Example

use std::env;
use seahorse::App;

let args: Vec<String> = env::args().collect();
let app = App::new("cli");
app.run(args);

Trait Implementations

impl Default for App

fn default() -> App

Returns the “default value” for a type.