subcmd 0.1.0

Cargo like subcommand parser
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

// Copyright © 2015 - Samuel Dolt <samuel@dolt.ch>
//
// Licensed under the MIT license. This file may not be copied, modified,
// or distributed except according to those terms.
//
// See the COPYRIGHT file at the top-level directory of this distribution.

use Message;
use CmdWrapper;

/// Result of a CmdHandler::run
///
/// # Usage
///
/// ```
/// use subcmd::CmdHandler;
/// use subcmd::CmdResult;
///
/// let handler = CmdHandler::new();
/// match handler.run() {
///     CmdResult::Help(msg)           => msg.print(),
///     CmdResult::HelpForCmd(cmd)     => cmd.print_help(),
///     CmdResult::BadUsage(msg)       => msg.print(),
///     CmdResult::UnknowCmd(msg)      => msg.print(),
///     CmdResult::Cmd(cmd)            => cmd.run(),
/// }
/// ```
pub enum CmdResult {
    /// Help has been requested with `-h` or `--help`
    Help(Message),

    /// Help for a command has been requested with `help cmd`
    HelpForCmd(CmdWrapper),

    /// A unknow option like `--unknow-option` has been requested
    BadUsage(Message),

    /// A unknow command like `unknow-command` has been requested
    UnknowCmd(Message),

    /// A know command has been requested
    Cmd(CmdWrapper),
}