はじめに
この記事は、産技品川 Advent Calendar 2025 7日目の記事です。
treeコマンドに似たプログラムを作成せよという学校の課題を終わらせ、点数までもらったので忘備録代わりに書いていこうと思います。コードの綺麗さは期待しないようにお願いします。また、プログラミングの知識がある程度ある前提で話しています。
以下の環境で実装をしています。
ハードウェア
| コンピュータ | CPU | MEM |
|---|---|---|
| Macbook Air(2023) | Apple M3 | 16GB |
ソフトウェア
| ソフトウェア | Version |
|---|---|
| MacOS | 15.7.2 |
| Cargo | 1.86.0 |
treeコマンドとは
指定したディレクトリに対して構造をグラフィカルに表示します。
macの方はbrewで以下のコマンドをタイプしましょう。
brew install tree
試しに今回使うcargoプロジェクト内でtreeコマンドを実行してみます。
% tree -a .
.
├── .gitignore
├── Cargo.lock
├── Cargo.toml
├── src
│ ├── lib.rs
│ └── main.rs
└── tests
├── cli.rs
└── expected
├── test_tree_with_a_multiple_paths.out
├── test_tree_with_a.out
├── test_tree_with_ad_multiple_paths.out
├── test_tree_with_ad.out
├── test_tree_with_d_multiple_paths.out
├── test_tree_with_d.out
├── test_tree_with_multiple_paths.out
└── test_tree.out
4 directories, 14 files
Cargo.tomlに依存関係を記述
Cargo.tomlに依存関係を記述します。
引数の定義にはclapを使用します。clapについては以下のページを見てください。
https://docs.rs/clap/latest/clap/
直接書いてもいいですし、以下のコマンドを実行しても良いでしょう。また、今回は授業の関係でclapは2.33を使用しています。
cargo add clap@2.33
最終的なCargo.tomlは以下のようになります。
[package]
name = "tree"
version = "0.1.0"
edition = "2024"
[dependencies]
clap = "2.33"
main.rsにmain関数を書く
main.rsにmain関数を定義します。
fn main() {
let mut config = match tree::get_args() {
Ok(cfg) => cfg,
Err(e) => { // get_args関数がerror型を返すなら
eprintln!("Error: {}", e); // エラーの内容を表示
std::process::exit(1); // エラーコード1を出して終了
}
}; // Config構造体をmutableで受け取れるようにするために定義している。
if let Err(e) = tree::run(&mut config) { // runがerror型を返すなら
eprintln!("Error: {}", e); // エラーの内容を表示
std::process::exit(1); // エラーコード1を出して終了
}
}
型、構造体、引数の定義
型と構造体の定義をします。lib.rsに記述しています。
use clap::{App, Arg};
use std::{error::Error, fs};
type MyResult<T> = Result<T, Box<dyn Error>>; //返す型の定義
#[derive(Debug)]
pub struct Config {
paths: Vec<String>, // Stringのベクタ
dir_count: usize, // ディレクトリをカウントする正の整数型
file_count: usize, // ファイルをカウントする正の整数型
is_all: bool, // 隠しファイルを表示するかどうかのbool型
}
clapを使ってget_args関数を定義します。
pub fn get_args() -> MyResult<Config> { // Config構造体を返す関数
let matches = App::new("tree")
.version("0.1.0")
.about("A tree-like command written in Rust")
.arg(
Arg::with_name("paths")
.value_name("PATH")
.help("Paths to search")
.default_value(".") //デフォルトの値を設定する
.multiple(true) // 複数のファイルの受け取り
)
.arg(
Arg::with_name("with_hidden_files")
.value_name("ALL")
.short("a")
.long("all")
.help("Include hidden files and directories")
.takes_value(false) // この引数は値を受け取らない
)
.get_matches();
Ok(Config {
paths: matches.values_of_lossy("paths").unwrap(), //デフォルトの値が入っているのでunwrapしても安全
dir_count: 0, //デフォルトの値は0
file_count: 0, // デフォルトの値は0
is_all: matches.is_present("with_hidden_files"), //フラグが立っているかどうか
})
}
こうすることで
tree [FLAGS] [PATH]...
を定義できます。
run関数の定義
lib.rsに以下のコードを記述します。
pub fn run(config: &mut Config) -> MyResult<()> {
let paths_clone = config.paths.clone(); // ベクタのコピーを作る
for path_str in paths_clone {
match fs::metadata(&path_str) {
Ok(meta) if meta.is_dir() => { //引数で渡されたものがディレクトリなら
config.dir_count += 1; //ディレクトリをカウント
println!("{}", path_str); //根のディレクトリ名を表示
visit_dirs(path_str.as_str(), &[], config)?; //visit_dirsで探索開始
}
Ok(_) => { //もしファイルなら
config.file_count += 1; //ファイルをカウント
println!("{} is not a directory", path_str); //ディレクトリでないことを表示
}
Err(_) => { //存在しないファイルまたはディレクトリなら
println!("Error: No such file or directory (os error 2)");
}
}
}
println!();
println!("{} directories, {} files", config.dir_count, config.file_count);
Ok(())
}
ここではディレクトリの場合、ファイルの場合、存在しないファイルまたはディレクトリの場合に分けています。厳密にはtreeの動作と少し異なりますがエラーハンドリングできているので良いとします。
visit_dirs関数の定義
今回のミソです。難しいと思うのでコードの下に解説を載せています。
fn visit_dirs(dir: &str, parents_last: &[bool], config: &mut Config) -> MyResult<()> {
let entries_result = fs::read_dir(dir); //ディレクトリを一階層分読み込む
if entries_result.is_err() {
return Ok(());
}
let mut entries = entries_result.unwrap()
.filter_map(Result::ok) //読み込み可能なものに絞る
.filter(|e| {
config.is_all || !e.file_name().to_string_lossy().starts_with('.')
}) /*get_argsで定義したis_allがtrueなら全て表示する
またはis_allが立っていないとき隠しファイルでないファイルに絞る*/
.collect::<Vec<_>>(); //ベクタにする
entries.sort_by_key(|entry| entry.file_name()); //名前順にする
for count in 0..entries.len() {
let entry = &entries[count]; //ディレクトリ配下の要素を一つずつ取り出す
let path = entry.path(); //ディレクトリかファイルかどうかを判断するため
let is_last = {count == entries.len() - 1}; //その階層の最後の要素かどうか
let mut indent = String::new();
for &last in parents_last { //parents_lastはboolのベクタ
indent.push_str(if last { " " } else { "│ " });
}
let branch = if is_last { "└── " } else { "├── " };
println!("{}{}{}", indent, branch, entry.file_name().to_string_lossy()); //ファイル名またはディレクトリ名を表示
if path.is_dir() {
config.dir_count += 1; //ディレクトリをカウント
let mut next_parents_last = parents_last.to_vec();
next_parents_last.push(is_last); //mutableなベクタに最後の要素かどうかのboolを加える
visit_dirs(path.to_str().unwrap(), &next_parents_last, config)?; //再起
} else {
config.file_count += 1;
}
}
Ok(())
}
entriesを定義するとき、filterメソッドを使い表示するものを選択しています。例えば以下のような名前を持つファイルがあるとします。もし、config.allがtrueなら下記二つを全て表示、もしfalseならファイル名が.から始まらないもの、つまり、fooだけを表示します。
foo
.hoge
ソートする部分は厳密にはtreeのアルゴリズムとは異なるようですが簡潔に実装するために名前順(ASCII順)にしておきます。
entries.sort_by_key(|entry| entry.file_name());
forループのところは最初は使わないので一回スルーしておきます。
そして次にbranchを定義しているところに移ります。
これは最初のあたりのディレクトリ構造を見てもらえばわかると思いますが、その階層の最後の要素なら"└── "を表示し、それ以外なら"├── "を表示させています。それを判断しているのがis_lastというわけです。
let is_last = {count == entries.len() - 1};
let branch = if is_last { "└── " } else { "├── " };
さて、再起に入ります。ここで、is_lastの情報を次に引き継ぐためにベクタに格納します。
let mut next_parents_last = parents_last.to_vec();
next_parents_last.push(is_last);
再起する前にfalseを格納していた場合とtrueを格納した場合で分けて考えることにします。
以下のforループについて考えてみます。
for &last in parents_last {
indent.push_str(if last { " " } else { "│ " });
}
parents_lastには再起する前のis_lastが格納されています。
もしparents_lastに格納されたbool値がfalseだとします。ここでfalseの場合というのは、同じ階層にまだ要素が残っていることになります。最初に表示させたディレクトリ構造の一部分を切り取った部分を貼っておきます。
├── src
│ ├── lib.rs <- ココ
│ └── main.rs <- ココ
└── tests
is_lastはその階層の最後の要素かどうかを示していました。なので、この例において、testsをまだ処理していないのでfalseになり、このような表示になるわけです。
逆にtrueのときというのはその逆です。最初に表示したディレクトリ構造の以下の部分にあたります。
└── tests
├── cli.rs <- ココ
└── expected <- ココ
その階層に他のディレクトリやファイルはいないので縦棒を表示する必要がありません。なので空白を入れた表示となるわけです。あとはこれを深さ分だけboolの処理をすることで適切な表示になります。
最終的なコード
use clap::{App, Arg};
use std::{error::Error, fs};
type MyResult<T> = Result<T, Box<dyn Error>>; //返す型の定義
#[derive(Debug)]
pub struct Config {
paths: Vec<String>, // Stringのベクタ
dir_count: usize, // ディレクトリをカウントする正の整数型
file_count: usize, // ファイルをカウントする正の整数型
is_all: bool, // 隠しファイルを表示するかどうかのbool型
}
pub fn get_args() -> MyResult<Config> { // Config構造体を返す関数
let matches = App::new("tree")
.version("0.1.0")
.about("A tree-like command written in Rust")
.arg(
Arg::with_name("paths")
.value_name("PATH")
.help("Paths to search")
.default_value(".") //デフォルトの値を設定する
.multiple(true) // 複数のファイルの受け取り
)
.arg(
Arg::with_name("with_hidden_files")
.value_name("ALL")
.short("a")
.long("all")
.help("Include hidden files and directories")
.takes_value(false) // この引数は値を受け取らない
)
.get_matches();
Ok(Config {
paths: matches.values_of_lossy("paths").unwrap(), //デフォルトの値が入っているのでunwrapしても安全
dir_count: 0, //デフォルトの値は0
file_count: 0, // デフォルトの値は0
is_all: matches.is_present("with_hidden_files"), //フラグが立っているかどうか
})
}
pub fn run(config: &mut Config) -> MyResult<()> {
let paths_clone = config.paths.clone(); // ベクタのコピーを作る
for path_str in paths_clone {
match fs::metadata(&path_str) {
Ok(meta) if meta.is_dir() => { //引数で渡されたものがディレクトリなら
config.dir_count += 1; //ディレクトリをカウント
println!("{}", path_str); //根のディレクトリ名を表示
visit_dirs(path_str.as_str(), &[], config)?; //visit_dirsで探索開始
}
Ok(_) => { //もしファイルなら
config.file_count += 1; //ファイルをカウント
println!("{} is not a directory", path_str); //ディレクトリでないことを表示
}
Err(_) => { //存在しないファイルまたはディレクトリなら
println!("Error: No such file or directory (os error 2)");
}
}
}
println!();
println!("{} directories, {} files", config.dir_count, config.file_count);
Ok(())
}
fn visit_dirs(dir: &str, parents_last: &[bool], config: &mut Config) -> MyResult<()> {
let entries_result = fs::read_dir(dir); //ディレクトリを一階層分読み込む
if entries_result.is_err() {
return Ok(());
}
let mut entries = entries_result.unwrap()
.filter_map(Result::ok) //読み込み可能なものに絞る
.filter(|e| {
config.is_all || !e.file_name().to_string_lossy().starts_with('.')
}) /*get_argsで定義したis_allがtrueなら全て表示する
またはis_allが立っていないとき隠しファイルでないファイルに絞る*/
.collect::<Vec<_>>(); //ベクタにする
entries.sort_by_key(|entry| entry.file_name()); //名前順にする
for count in 0..entries.len() {
let entry = &entries[count]; //ディレクトリ配下の要素を一つずつ取り出す
let path = entry.path(); //ディレクトリかファイルかどうかを判断するため
let is_last = {count == entries.len() - 1}; //その階層の最後の要素かどうか
let mut indent = String::new();
for &last in parents_last { //parents_lastはboolのベクタ
indent.push_str(if last { " " } else { "│ " });
}
let branch = if is_last { "└── " } else { "├── " };
println!("{}{}{}", indent, branch, entry.file_name().to_string_lossy()); //ファイル名またはディレクトリ名を表示
if path.is_dir() {
config.dir_count += 1; //ディレクトリをカウント
let mut next_parents_last = parents_last.to_vec();
next_parents_last.push(is_last); //mutableなベクタに最後の要素かどうかのboolを加える
visit_dirs(path.to_str().unwrap(), &next_parents_last, config)?; //再起
} else {
config.file_count += 1;
}
}
Ok(())
}
終わりに
始めてのQiitaでしたがここまで読んでくださってありがとうございました。
またネタが生まれれば不定期で書きたいと思います。