如何访问命令行参数?


153

锈教程并没有解释如何在命令行中带参数。fn main()在所有示例中,仅显示一个空参数列表。

从中访问命令行参数的正确方法是main什么?

Answers:


168

您可以使用std::env::argsstd::env::args_os函数访问命令行参数。这两个函数都在参数上返回一个迭代器。前者遍历Strings(易于使用),但如果其中一个参数不是有效的unicode,则会感到恐慌。后者遍历OsStrings且永不慌乱。

请注意,迭代器的第一个元素是程序本身的名称(这是所有主要操作系统中的约定),因此第一个参数实际上是第二个迭代的元素。

处理结果的一种简单方法args是将其转换为Vec

use std::env;

fn main() {
    let args: Vec<_> = env::args().collect();
    if args.len() > 1 {
        println!("The first argument is {}", args[1]);
    }
}

您可以使用整个标准迭代器工具箱来使用这些参数。例如,仅检索第一个参数:

use std::env;

fn main() {
    if let Some(arg1) = env::args().nth(1) {
        println!("The first argument is {}", arg1);
    }
}

您可以在crates.io找到用于解析命令行参数的库:

  • docopt:您只需编写帮助消息,便会为您生成解析代码。
  • clap:您描述要使用流利的API解析的选项。比docopt更快,并提供了更多控制权。
  • getopts:流行的C库的端口。下级甚至更多的控制权。
  • structopt:基于拍手声,使用起来更加符合人体工程学。

2
同样使用锈迹0.8,您应该只使用println(args[0])
Leo Correa

6
上面的评论(@LeoCorrea / @ S4M)引用了答案的旧版本;答案的当前版本包含最新信息。
Nickolay

22

Docopt也可用于Rust,Rust从使用情况字符串为您生成解析器。作为Rust的附加功能,宏可用于自动生成结构并执行基于类型的解码:

docopt!(Args, "
Usage: cp [-a] SOURCE DEST
       cp [-a] SOURCE... DIR

Options:
    -a, --archive  Copy everything.
")

您可以通过以下方式获得参数:

let args: Args = Args::docopt().decode().unwrap_or_else(|e| e.exit());

自述文件文档包含大量完整的工作示例。

免责声明:我是该库的作者之一。



10

对我来说,getopts总是感觉太低级,而docopt.rs太神奇了。我想要一些明确而直接的东西,如果我需要它们,它仍然可以提供所有功能。

这是拍手派上用场的地方。
感觉有点像Python中的argparse。这是一个看起来像的例子:

let matches = App::new("myapp")
                      .version("1.0")
                      .author("Kevin K. <kbknapp@gmail.com>")
                      .about("Does awesome things")
                      .arg(Arg::with_name("CONFIG")
                           .short("c")
                           .long("config")
                           .help("Sets a custom config file")
                           .takes_value(true))
                      .arg(Arg::with_name("INPUT")
                           .help("Sets the input file to use")
                           .required(true)
                           .index(1))
                      .arg(Arg::with_name("debug")
                           .short("d")
                           .multiple(true)
                           .help("Sets the level of debugging information"))
                      .get_matches();

您可以像这样访问参数:

println!("Using input file: {}", matches.value_of("INPUT").unwrap());

// Gets a value for config if supplied by user, or defaults to "default.conf"
let config = matches.value_of("CONFIG").unwrap_or("default.conf");
println!("Value for config: {}", config);

(摘自官方文件


1
我喜欢clap-rs,可让您在yaml文件中定义界面。而且,它会产生非常漂亮的用法说明。
Chuck Wooters

这有助于我快速设置CLI应用程序。谢谢!
dimitarvp

4

从版本0.8 / 0.9开始,函数args()的正确路径为::std::os::args,即:

fn main() {
  let args: ~[~str] = ::std::os::args();
  println(args[0]);
}

现在,即使使用标准IO,Rust似乎仍然非常不稳定,因此这可能很快就会过时。


感谢更新!猜猜我将在1.0发布后重新考虑接受的答案。
shutefan 2014年

3

锈再次变了。os::args()不推荐使用std::args()。但std::args()它不是数组,它返回一个迭代器。您可以遍历命令行参数,但不能使用下标访问它们。

http://doc.rust-lang.org/std/env/fn.args.html

如果您希望命令行参数作为字符串向量,则现在可以使用:

use std::env;
...
let args: Vec<String> = env::args().map(|s| s.into_string().unwrap()).collect();

锈-学会拥抱变化的痛苦。


8
您现在只需要这样做env::args().collect()
tshepang

2

@barjak所说的内容适用于字符串,但是如果您需要将参数作为数字(在本例中为uint),则需要这样转换:

fn main() {
    let arg : ~[~str] = os::args();
    match uint::from_str(arg[1]){
         Some(x)=>io::println(fmt!("%u",someFunction(x))),
         None=>io::println("I need a real number")
    }
}

2

还检查structopt:

extern crate structopt;
#[macro_use]
extern crate structopt_derive;

use structopt::StructOpt;

#[derive(StructOpt, Debug)]
#[structopt(name = "example", about = "An example of StructOpt usage.")]
struct Opt {
    /// A flag, true if used in the command line.
    #[structopt(short = "d", long = "debug", help = "Activate debug mode")]
    debug: bool,

    /// An argument of type float, with a default value.
    #[structopt(short = "s", long = "speed", help = "Set speed", default_value = "42")]
    speed: f64,

    /// Needed parameter, the first on the command line.
    #[structopt(help = "Input file")]
    input: String,

    /// An optional parameter, will be `None` if not present on the
    /// command line.
    #[structopt(help = "Output file, stdout if not present")]
    output: Option<String>,
}

fn main() {
    let opt = Opt::from_args();
    println!("{:?}", opt);
}

https://github.com/TeXitoi/structopt


1

从较新的Rust版本(Rust> 0.10 / 11)开始,数组语法将不起作用。您将必须使用get方法。

[编辑]数组语法每晚(再次)起作用。因此,您可以在getter或数组索引之间进行选择。

use std::os;

fn main() {
  let args = os::args();
  println!("{}", args.get(1));
}

// Compile
 rustc args.rs && ./args hello-world // returns hello-world

这是过时的声明。最新的Rust Nightlies确实支持上的索引语法Vec。我猜它在那里存在了一个月左右。请参阅此示例
弗拉基米尔·马特维耶夫(Fladimir Matveev)2014年

1

自2013年5月加尔文(Calvin)回答以来,Rust已经发展起来。现在可以使用以下命令解析命令行参数as_slice()

use std::os;

fn seen_arg(x: uint)
{       
    println!("you passed me {}", x);
}
fn main() {
    let args = os::args();
    let args = args.as_slice();
    let nitems = {
            if args.len() == 2 {
                    from_str::<uint>(args[1].as_slice()).unwrap()
            } else {
                    10000
            }
    };

    seen_arg(nitems);
}

仅作记录:as_slice()不再存在,&args应改为使用。
Slava Semushin

1

锈书“没有STDLIB”一章介绍了如何访问命令行参数(另一种方式)。

// Entry point for this program
#[start]
fn start(_argc: isize, _argv: *const *const u8) -> isize {
    0
}

现在,该示例确实也包含#![no_std]了我认为意味着std库通常具有二进制文件的真实入口点并调用名为的全局函数main()。另一种选择是使用来“禁用main垫片” #![no_main]。如果我没记错的话,那是对编译器说,您正在完全控制程序的启动方式。

#![no_std]
#![no_main]

#[no_mangle] // ensure that this symbol is called `main` in the output
pub extern fn main(argc: isize, argv: *const *const u8) -> isize {
    0
}

如果您只想读取命令行参数,我认为这不是一种“好的”处理方式。std::os其他答案中提到的模块似乎是一种更好的处理方式。为了完整起见,我发布了这个答案。

By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.