cliproc

此库提供了快速、低级且可配置的命令行处理支持。

[dependencies]
cliproc = "2.1.1"

示例

use cliproc::{cli, proc, stage::Memory};
use cliproc::{Arg, Cli, Command, ExitCode, Help};
use std::env;

// 1. Define the struct and the data required to perform its task
struct Demo {
    name: String,
    count: Option<u8>,
}

// 2. Implement the `Command` trait to allow a struct to function as a command
impl Command for Demo {
    // 2a. Map the command-line data to the struct's data
    fn interpret(cli: &mut Cli<Memory>) -> cli::Result<Self> {
        cli.help(Help::with(HELP))?;
        Ok(Demo {
            name: cli.require(Arg::option("name").switch('n'))?,
            count: cli.get(Arg::option("count").switch('c'))?,
        })
    }

    // 2b. Process the struct's data to perform its task
    fn execute(self) -> proc::Result {
        for _ in 0..self.count.unwrap_or(1) {
            println!("Hello {}!", self.name);
        }
        Ok(())
    }
}

// 3. Build the command-line processor and run the command
fn main() -> ExitCode {
    Cli::default().parse(env::args()).go::<Demo>()
}

const HELP: &str = "\
A fast, low-level, and configurable command-line processor.

Usage:
    demo [options] --name <name>
    
Options:
    --name, -n <name>       Name of the person to greet              
    --count, -c <count>     Number of times to greet (default: 1)
    --help, -h              Print this help information and exit
";

请参阅 examples/ 文件夹以获取更多演示。

详细信息

命令行处理器分为 3 个阶段：构建、就绪和内存。它使用类型状态模式实现，以在编译时强制执行有效的状态操作和状态转换。

1. 构建阶段：构建阶段提供配置命令行处理器的方法。此阶段使用构建器模式设置选项。

2. 就绪阶段：就绪阶段提供确定如何运行命令行处理器的方法。

3. 内存阶段：内存阶段提供处理来自命令行的数据请求的方法。这是命令行处理器的最终阶段。

转换

使用 parse(...) 解析一组参数会将命令行处理器从构建阶段转换为就绪阶段。

在就绪阶段，处理器有两个选择：运行或保存

• go() 通过转换为内存阶段并处理调用指定结构作为命令（实现 Command 特性）来运行处理器，直到完成。这是运行处理器的推荐选择。

• save() 通过仅将处理器转换为内存阶段来推迟命令解释和执行。这允许程序员显式地处理调用指定的结构作为命令。

命令

从命令行接收到的原始字符串向量被处理，将字符串转换为要由实现 Command 特性的结构解释的标记。

任何结构都可以作为命令/子命令使用，只要

1. 结构体中每个字段的类型都实现了标准库中的 std::str::FromStr 特性。
2. 该结构体实现了 cliproc 的 Command（或 Subcommand）特性。

参数

cliproc 识别以下 4 种类型的参数

• 标志：布尔条件（例如：--verbose）
• 选项：任意类型，以键/值对的形式指定（例如：--output <file>）
• 位置参数：任意类型，基于在参数列表中的位置指定（例如：<name>）
• 子命令：任意类型，用于嵌套包含自己参数集的命令（例如：<command>）