Rustでmkdir -pみたいな簡単なCLIツールを作って学んだこと

競技プログラミングを再開しようとして、Rust でディレクトリをつくるのがめんどくさいことに気づきました。 mkdir -p のような CLI ツールを作ったときに学んだメモです。

StructOpt で引数パース

Rust のコマンドライン引数パーサというと、clapが有名だが、最近は StructOpt もよく見かけるのでこちらを使った。今調べたところ、StructOpt は clap v2.33 に依存しているらしい。
以下のように、コマンドライン引数を struct へ変換する。引数から struct のメンバへの変換時の validation は、parse する関数を指定できて、今回は parse_mydir_rule という関数を作ってそれを指定している。

#[derive(StructOpt, Debug)]
#[structopt(name = "pdir")]
struct Opt {
    #[structopt(short)]
    atcoder: bool,
    /// Each directory
    #[structopt(name = "DIR", parse(try_from_str = parse_mydir_rule))]
    dirs: Vec<String>,
}
fn main() {
    let opt = Opt::from_args();
    println!("{:#?}", opt);
}

OnceCell で初期化処理

初期化処理を行い static な global 変数を作る方法として、 lazy_static が有名だが、最近は OnceCell も使われている。
今回は、ファイル名を数字アルファベット大文字小文字、ハイフン、アンダーバー、ドットのみに制限したかったので regex クレートを使ったが、このとき毎回 Regex を生成しているのかよく分からず、初期化したとき一度だけ計算するようにしたくて使った。

use regex::Regex;
use once_cell::sync::Lazy;

static DIR_REGEX: Lazy<Regex> = Lazy::new(|| Regex::new("[a-zA-Z0-9-_\\.]+").unwrap());

cargo workspaces で管理する

競技プログラミングでは rustc コマンドで直接やっていたが、VSCode との相性や cargo に乗っかりたい気持ちから各 A~F 問題をそれぞれ main.rs で書きたいと考え、workspaces を使うことにした。
今回使った特徴は、workspace 全体を設定するディレクトリから各ディレクトリの main.rs が実行できる機能です。
以下のようなディレクトリ構成で、 atcoder/abcXYZ/ で cargo run -p a とすると、 a ディレクトリで cargo run したのと同じことができて、 target ディレクトリは abcXYZ/ ディレクトリにしか生成されません。
また、run は r のエイリアスがあるので、Makefile などで make a として cargo r -p a のようにすることも可能です。
今回作成した pdir では、 pdir atcoder abcXYZ -a というコマンドで atcoder/abcXYZ/a/, ...が生成されるようにしています。

atcoder/abcXYZ/
├── a
│   ├── Cargo.toml
│   └── src
│       └── main.rs
├── b
│   ├── Cargo.toml
│   └── src
│       └── main.rs
├── c
│   ├── Cargo.toml
│   └── src
│       └── main.rs
├── Cargo.lock
├── Cargo.toml # workspaces
├── d
│   ├── Cargo.toml
│   └── src
│       └── main.rs
├── e
│   ├── Cargo.toml
│   └── src
│       └── main.rs
├── f
│   ├── Cargo.toml
│   └── src
│       └── main.rs
└── target

[workspace]
members = [
    "a",
    "b",
    "c",
    "d",
    "e",
    "f",
]

文字列の concat は join を使おう

文字列の連結は、引数のスペース区切りの単語を / で連結するようにした。

let path = opt.dirs.join("/");
let path = path.as_str();

[path, "Cargo.toml"].join("/"); // a/b/c/Cargo.toml

文字列の扱いが難しい

上の join のところで、以下のようにするとだめになりました。やりたいことは、String だと使い回せないので&str にして使いまわそうということです。
エラーメッセージもまだ借用きちんと理解できてなくて分からない感じなので、いい方法があれば知りたいです。

let path = opt.dirs.join("/").as_str();

最小の再現コードです
https://play.rust-lang.org/?version=stable&mode=debug&edition=2018&gist=9b7aa9be5339c8c3b1c8373fefa8700f

error[E0716]: temporary value dropped while borrowed
 --> src/main.rs:4:14
  |
4 |     let st = ["a", "b", "c"].join("/").as_str();
  |              ^^^^^^^^^^^^^^^^^^^^^^^^^         - temporary value is freed at the end of this statement
  |              |
  |              creates a temporary which is freed while still in use
5 |     println!("{}", st);
  |                    -- borrow later used here
  |
  = note: consider using a `let` binding to create a longer lived value

anyhow と thiserror の組み合わせが分からない

anyhow の Result を返す関数で、thiserror を使った enum でエラーを返そうとしたら、それは anyhow のエラー型ではありませんよと言われた。結局 Err(anyhow!("message")) としたが、thiserror でエラーメッセージとエラー型を一括管理できる恩恵を受けたいときに微妙になってしまう。ドキュメントを見てもよく分からなかったので、使われている例を探したい。

Command が便利

下のように、コマンドオプションがオンになっていたら、ディレクトリを cargo を流して作成し、workspace のところは直接ファイルを生成するようにした。個人的にわかりやすいコマンド体系で、変数を直接入れることは危険なため避けるが、こういう固定のコマンド発行のときは使っていくつもり。

use std::process::Command;

if opt.atcoder {
    // cargo new a..f
    for ch in 'a'..='f' {
        Command::new("cargo")
            .args(&["new", "--bin", ch.to_string().as_str()])
            .current_dir(path).output()?;
    }
    // make Cargo.toml (workspace)
    let mut file = fs::File::create([path, "Cargo.toml"].join("/"))?;
    let content = r###"[workspace]
members = [
"a",
"b",
"c",
"d",
"e",
"f",
]"###;
    write!(file, "{}", content)?;
    file.flush()?;
}