MENU
  1. ホーム
  2. Rust
  3. Rustで進捗バーを簡単に実装する方法！indicatifクレート徹底解説

Rustで進捗バーを簡単に実装する方法！indicatifクレート徹底解説

Rust

Rustでタスクの進行状況を視覚的に示す際、進捗バーを表示するのは効果的な手段です。例えば、長いファイル処理、データダウンロード、大規模な計算処理など、どれくらい処理が進んだのかユーザーに知らせることができます。Rustには、この進捗表示を手軽に実装できるindicatifクレートがあります。

本記事では、indicatifクレートを使った進捗バーの基本的な実装から応用例まで、実際のコードを交えて詳しく解説します。進捗バーのカスタマイズ方法やスピナーの導入、複数の進捗バーの管理方法など、Rustで効率的に進捗状況を可視化するためのテクニックを習得しましょう。

目次

`indicatif`クレートとは

indicatifクレートは、Rustで進捗バーやスピナーを簡単に実装できるライブラリです。タスクの進行状況をリアルタイムで視覚的に表示できるため、ユーザーが処理の進捗状況を把握しやすくなります。

進捗バーが必要な理由

進捗バーは、次のような場面で非常に有効です：

  • 長時間の処理：データのダウンロード、ファイル処理、大規模な計算など、処理が長時間かかる際に進捗状況を知らせることでユーザーの不安を軽減します。
  • ユーザー体験の向上：処理が順調に進んでいることを示すことで、ユーザーに安心感を与えます。
  • デバッグやパフォーマンス確認：処理時間を計測し、どのタスクがボトルネックになっているかを確認する際にも役立ちます。

`indicatif`の特徴

  • シンプルなAPI：簡単に導入でき、少ないコードで進捗バーを表示可能。
  • 多機能：複数の進捗バー、スピナー、ETA（予想完了時間）の表示が可能。
  • カスタマイズ性：スタイルやフォーマットを柔軟に変更できるため、プロジェクトの要件に応じた表示が可能。

これにより、indicatifはRustのCLIアプリケーションや長時間の処理を伴うタスクにおいて、非常に便利なクレートとなっています。

`indicatif`のインストール方法

Rustのプロジェクトにindicatifクレートを追加するには、Cargoを使用します。以下の手順でインストールを行います。

Cargo.tomlへの依存関係追加

まず、プロジェクトのCargo.tomlファイルにindicatifを追加します。最新バージョンを確認して追加してください。

[dependencies]
indicatif = "0.17"  # バージョン番号は最新のものを指定

インストールの実行

ターミナルで以下のコマンドを実行し、依存関係をインストールします。

cargo build

これでindicatifがインストールされ、プロジェクトで使用できるようになります。

インストール確認

以下のサンプルコードを実行し、インストールが正常に完了したことを確認しましょう。

use indicatif::ProgressBar;
use std::thread;
use std::time::Duration;

fn main() {
    let bar = ProgressBar::new(100);
    for i in 0..100 {
        bar.inc(1);
        thread::sleep(Duration::from_millis(50));
    }
    bar.finish();
}

このコードをmain.rsに記述し、以下のコマンドで実行します。

cargo run

正常にインストールされていれば、進捗バーが表示され、0から100までカウントが進みます。

シンプルな進捗バーの実装

indicatifクレートを使った基本的な進捗バーの実装方法を紹介します。これにより、Rustのプログラムでタスクの進行状況を簡単に表示できるようになります。

基本的な進捗バーの作成

以下のコードは、シンプルな進捗バーを表示するサンプルです。タスクの進行に応じてバーが更新されます。

use indicatif::ProgressBar;
use std::thread;
use std::time::Duration;

fn main() {
    // 進捗バーを作成し、タスクの総数を指定する
    let bar = ProgressBar::new(100);

    for _ in 0..100 {
        bar.inc(1); // 進捗バーを1つ進める
        thread::sleep(Duration::from_millis(50)); // 50ミリ秒待機
    }

    bar.finish(); // 進捗バーの完了を宣言
}

コードの解説

  1. ProgressBar::new(100)
  • タスクの総数として100を設定した進捗バーを作成します。
  1. bar.inc(1)
  • 進捗バーを1つ進めます。ループが100回実行されるため、最終的に100まで進みます。
  1. thread::sleep(Duration::from_millis(50))
  • 各ループごとに50ミリ秒待機することで、進捗バーが徐々に進む様子を表示します。
  1. bar.finish()
  • 進捗バーを完了としてマークします。

実行結果

プログラムを実行すると、以下のような進捗バーが表示されます：

███████████████████████████████████████████████████ 100/100

進捗バーにメッセージを追加する

進捗バーにメッセージを表示することもできます。

use indicatif::ProgressBar;
use std::thread;
use std::time::Duration;

fn main() {
    let bar = ProgressBar::new(50);
    bar.set_message("処理中...");

    for _ in 0..50 {
        bar.inc(1);
        thread::sleep(Duration::from_millis(50));
    }

    bar.finish_with_message("処理が完了しました！");
}

実行結果

処理中... ████████████████████████████████████████ 50/50
処理が完了しました！

このように、indicatifを使えば、簡単に進捗バーを追加し、ユーザーに分かりやすい進行状況を提供できます。

複数の進捗バーを使う

indicatifクレートでは、複数のタスクの進捗状況を同時に表示することができます。これにより、複数の処理が並行して進んでいる場合でも、それぞれの進行状況を視覚的に把握できます。

複数の進捗バーの実装例

以下の例では、複数の進捗バーを並行して表示します。

use indicatif::{MultiProgress, ProgressBar, ProgressStyle};
use std::thread;
use std::time::Duration;

fn main() {
    // マルチプログレスバーを作成
    let m = MultiProgress::new();

    // 3つの異なる進捗バーを作成
    let pb1 = m.add(ProgressBar::new(100));
    let pb2 = m.add(ProgressBar::new(200));
    let pb3 = m.add(ProgressBar::new(150));

    // 進捗バーにスタイルを設定
    let style = ProgressStyle::default_bar()
        .template("{msg} [{bar:40.cyan/blue}] {pos}/{len} ({eta})")
        .unwrap();

    pb1.set_style(style.clone());
    pb1.set_message("タスク 1");

    pb2.set_style(style.clone());
    pb2.set_message("タスク 2");

    pb3.set_style(style.clone());
    pb3.set_message("タスク 3");

    // 別スレッドでタスクを実行
    let h1 = thread::spawn(move || {
        for _ in 0..100 {
            pb1.inc(1);
            thread::sleep(Duration::from_millis(30));
        }
        pb1.finish_with_message("タスク 1 完了");
    });

    let h2 = thread::spawn(move || {
        for _ in 0..200 {
            pb2.inc(1);
            thread::sleep(Duration::from_millis(20));
        }
        pb2.finish_with_message("タスク 2 完了");
    });

    let h3 = thread::spawn(move || {
        for _ in 0..150 {
            pb3.inc(1);
            thread::sleep(Duration::from_millis(25));
        }
        pb3.finish_with_message("タスク 3 完了");
    });

    // 全てのスレッドの終了を待つ
    h1.join().unwrap();
    h2.join().unwrap();
    h3.join().unwrap();
}

コードの解説

  1. MultiProgress::new()
    複数の進捗バーを管理するためのMultiProgressインスタンスを作成します。
  2. m.add(ProgressBar::new(N))
    MultiProgressに新しい進捗バーを追加します。それぞれの進捗バーに異なるタスクの総数（N）を設定しています。
  3. ProgressStyleの設定
    進捗バーにカスタムスタイルを適用します。バーの色や表示フォーマットを設定できます。
  4. スレッドの作成
    各進捗バーは別スレッドで進行し、非同期に更新されます。
  5. join()でスレッドを待機
    メインスレッドで全てのタスクが完了するのを待ちます。

実行結果

タスク 1 [████████████████████████████████████████] 100/100 (00:00)
タスク 2 [████████████████████████████████████████] 200/200 (00:00)
タスク 3 [████████████████████████████████████████] 150/150 (00:00)

応用例

  • ダウンロードの並行処理：複数のファイルを同時にダウンロードする際、それぞれのダウンロード進捗を表示。
  • マルチスレッド処理の可視化：複数のタスクを並行して処理するプログラムで、進行状況を一目で確認。

複数の進捗バーを利用することで、タスクの並行処理が直感的に理解でき、ユーザー体験が向上します。

スピナー（ローディングアニメーション）の実装

indicatifクレートでは、進捗バーだけでなく、タスクの進行状況を示すスピナー（ローディングアニメーション）も簡単に実装できます。スピナーは、処理の完了までの進行度が不明な場合や短時間のタスクに適しています。

シンプルなスピナーの実装

以下のサンプルコードは、スピナーを使ってローディングアニメーションを表示する方法です。

use indicatif::{ProgressBar, ProgressStyle};
use std::thread;
use std::time::Duration;

fn main() {
    // スピナーを作成
    let spinner = ProgressBar::new_spinner();
    spinner.set_message("処理中...");

    // スタイルを設定
    spinner.set_style(
        ProgressStyle::default_spinner()
            .tick_chars("/|\\- ")  // スピナーのアニメーションパターン
            .template("{spinner:.green} {msg}")  // スピナーとメッセージのフォーマット
            .unwrap(),
    );

    // スピナーを回転させる
    for _ in 0..20 {
        spinner.tick(); // スピナーを1ステップ進める
        thread::sleep(Duration::from_millis(100)); // 100ミリ秒待機
    }

    spinner.finish_with_message("処理が完了しました！");
}

コードの解説

  1. ProgressBar::new_spinner()
  • スピナー用のProgressBarインスタンスを作成します。
  1. spinner.set_message("処理中...")
  • スピナーに表示するメッセージを設定します。
  1. ProgressStyle::default_spinner()
  • スピナーのスタイルをデフォルトのスタイルから設定します。
  1. tick_chars("/|\\- ")
  • スピナーのアニメーションに使う文字パターンを設定します。
  1. spinner.tick()
  • スピナーを1ステップ進めて、次のアニメーションに切り替えます。
  1. spinner.finish_with_message("処理が完了しました！")
  • スピナーの処理が完了したことを示し、終了メッセージを表示します。

実行結果

/ 処理中...
| 処理中...
\ 処理中...
- 処理中...
/ 処理中...
...
処理が完了しました！

スピナーのカスタマイズ

スピナーは、カスタム文字や色で自由にカスタマイズできます。

use indicatif::{ProgressBar, ProgressStyle};
use std::thread;
use std::time::Duration;

fn main() {
    let spinner = ProgressBar::new_spinner();
    spinner.set_style(
        ProgressStyle::default_spinner()
            .tick_chars("🌑🌒🌓🌔🌕🌖🌗🌘")  // 月の満ち欠けを使ったカスタムスピナー
            .template("{spinner:.cyan} {msg}")
            .unwrap(),
    );

    spinner.set_message("月のフェーズをロード中...");

    for _ in 0..20 {
        spinner.tick();
        thread::sleep(Duration::from_millis(150));
    }

    spinner.finish_with_message("ロード完了！");
}

応用例

  • データベースクエリ：クエリが完了するまで待つ際にスピナーを表示。
  • APIリクエスト：リクエスト処理中にスピナーでローディングを可視化。
  • ファイルダウンロード準備：ダウンロード開始前の準備段階でスピナーを使用。

スピナーを活用することで、タスクの待機時間中にユーザーが処理が進んでいることを直感的に理解できるため、CLIアプリケーションのユーザー体験が向上します。

進捗バーのカスタマイズ方法

indicatifクレートでは、進捗バーのスタイルや表示内容を柔軟にカスタマイズできます。カスタマイズを行うことで、見た目や情報表示をアプリケーションの要件に合わせることが可能です。

基本的なカスタマイズ

進捗バーの表示スタイルはProgressStyleを使って設定します。以下の例で基本的なカスタマイズを見ていきましょう。

use indicatif::{ProgressBar, ProgressStyle};
use std::thread;
use std::time::Duration;

fn main() {
    let bar = ProgressBar::new(100);

    // スタイルをカスタマイズ
    bar.set_style(ProgressStyle::default_bar()
        .template("[{elapsed_precise}] {bar:40.green/yellow} {pos:>3}/{len} {msg}")
        .unwrap()
        .progress_chars("=>-")); // 進捗バーのキャラクターを指定

    bar.set_message("処理中...");

    for _ in 0..100 {
        bar.inc(1);
        thread::sleep(Duration::from_millis(50));
    }

    bar.finish_with_message("処理が完了しました！");
}

コードの解説

  1. template
  • 進捗バーのフォーマットを設定します。プレースホルダを使って様々な情報を表示できます。
    • {elapsed_precise}：経過時間を表示。
    • {bar:40.green/yellow}：進捗バーを40文字分の長さで表示し、色を設定（進捗部分を緑、未進捗部分を黄色）。
    • {pos}：現在の進捗値。
    • {len}：タスクの総量。
    • {msg}：カスタムメッセージ。
  1. progress_chars("=>-")
  • 進捗バーのキャラクターを設定。進捗部分には=, 矢印の>, 未進捗部分には-を使用します。
  1. bar.set_message("処理中...")
  • 進捗バーに表示するメッセージを設定。

実行結果

[00:05] [========================================>     ]  90/100 処理中...

カスタマイズのオプション

  • カラースタイル：進捗バーやメッセージに色を付けることができます。
  bar.set_style(ProgressStyle::default_bar().template("{bar:.cyan} {pos}/{len}"));
  • ETA（予想完了時間）表示：
  bar.set_style(ProgressStyle::default_bar().template("{bar} {pos}/{len} ETA: {eta}"));
  • 進捗バーの長さ調整：バーの長さを指定することで、CLIの幅に合わせた調整が可能です。
  bar.set_style(ProgressStyle::default_bar().template("{bar:60} {pos}/{len}"));

スピナーのカスタマイズ

スピナーもカスタマイズできます。以下の例はカスタムスピナーを設定する方法です。

use indicatif::{ProgressBar, ProgressStyle};
use std::thread;
use std::time::Duration;

fn main() {
    let spinner = ProgressBar::new_spinner();
    spinner.set_style(ProgressStyle::default_spinner()
        .tick_chars("⠁⠂⠄⡀⢀⠠⠐⠈")
        .template("{spinner:.blue} {msg}")
        .unwrap());

    spinner.set_message("ローディング中...");

    for _ in 0..20 {
        spinner.tick();
        thread::sleep(Duration::from_millis(100));
    }

    spinner.finish_with_message("完了しました！");
}

実行結果

⠠ ローディング中...
⠐ ローディング中...
⠈ ローディング中...
完了しました！

応用例

  • ダウンロード進捗表示：ファイルサイズに応じた進捗バー。
  • ビルド進捗表示：複数ステップのビルドタスクで進捗を表示。
  • データ処理：大量データの処理進捗をカスタムバーで視覚化。

進捗バーやスピナーのカスタマイズを活用することで、アプリケーションのユーザー体験が大幅に向上します。

実際のアプリケーションでの使用例

indicatifクレートを用いた進捗バーの実装は、さまざまな実用的なアプリケーションで役立ちます。ここでは、具体的な使用例として、ファイルのダウンロードやデータ処理を行うプログラムを紹介します。

使用例1：ファイルのダウンロード進捗表示

以下の例は、複数のファイルをダウンロードする際に、進捗バーでダウンロードの進行状況を示す方法です。

use indicatif::{MultiProgress, ProgressBar, ProgressStyle};
use reqwest::blocking::get;
use std::fs::File;
use std::io::{copy, Write};
use std::thread;
use std::time::Duration;

fn download_file(url: &str, file_name: &str, pb: ProgressBar) {
    let response = get(url).expect("Failed to send request");
    let total_size = response.content_length().unwrap_or(0);
    pb.set_length(total_size);

    let mut dest = File::create(file_name).expect("Failed to create file");
    let mut content = response.bytes().expect("Failed to read content");

    let mut downloaded = 0;
    let chunk_size = 1024;
    while downloaded < total_size {
        let chunk = &content[..chunk_size.min(content.len())];
        dest.write_all(chunk).expect("Failed to write chunk");
        downloaded += chunk.len() as u64;
        pb.set_position(downloaded);
        thread::sleep(Duration::from_millis(50)); // ダウンロードのシミュレーション
    }

    pb.finish_with_message(&format!("{} のダウンロードが完了しました！", file_name));
}

fn main() {
    let urls = vec![
        ("https://example.com/file1", "file1.txt"),
        ("https://example.com/file2", "file2.txt"),
    ];

    let multi_progress = MultiProgress::new();
    let style = ProgressStyle::default_bar()
        .template("{msg} [{bar:40.cyan/blue}] {bytes}/{total_bytes} ({eta})")
        .unwrap();

    let handles: Vec<_> = urls.into_iter().map(|(url, file_name)| {
        let pb = multi_progress.add(ProgressBar::new(0));
        pb.set_style(style.clone());
        pb.set_message(format!("Downloading {}", file_name));
        thread::spawn(move || download_file(url, file_name, pb))
    }).collect();

    for handle in handles {
        handle.join().unwrap();
    }
}

コードの解説

  1. download_file関数
  • 指定したURLからファイルをダウンロードし、進捗バーを更新します。
  1. MultiProgress
  • 複数のダウンロードタスクを管理し、それぞれの進捗バーを同時に表示します。
  1. ProgressStyleのカスタマイズ
  • ダウンロードの進捗状況、バイト数、ETA（予想完了時間）を表示するフォーマットを設定します。
  1. スレッド化
  • 複数のファイルを並行してダウンロードするために、各ダウンロードタスクを別スレッドで実行します。

使用例2：大規模データ処理の進捗表示

大量のデータを処理する場合にも、進捗バーを使うと処理の進行状況が分かりやすくなります。

use indicatif::{ProgressBar, ProgressStyle};
use std::thread;
use std::time::Duration;

fn process_data(data_size: u64) {
    let bar = ProgressBar::new(data_size);
    bar.set_style(
        ProgressStyle::default_bar()
            .template("{bar:40.green} {pos}/{len} ({eta})")
            .unwrap(),
    );

    for i in 0..data_size {
        // データ処理のシミュレーション
        thread::sleep(Duration::from_millis(10));
        bar.inc(1);
    }

    bar.finish_with_message("データ処理が完了しました！");
}

fn main() {
    let data_size = 500;
    println!("データ処理を開始します...");
    process_data(data_size);
}

実行結果

データ処理を開始します...
████████████████████████████████████████ 500/500 (00:05)
データ処理が完了しました！

応用例

  1. バックアップ処理
    複数のファイルやフォルダをバックアップする際、進捗バーを表示して進行状況を可視化。
  2. データベースマイグレーション
    大量のデータを移行する際、処理の進捗を確認するために使用。
  3. APIリクエストのバッチ処理
    複数のAPIリクエストを順次処理する際、進捗バーを活用。

これらの使用例を参考に、実際のアプリケーションで効率的にindicatifを活用しましょう。進捗バーを導入することで、ユーザーに分かりやすいフィードバックを提供し、プログラムの操作性と透明性を向上させることができます。

エラーハンドリングとトラブルシューティング

indicatifクレートを使った進捗バーの実装中に発生しやすいエラーとその解決方法について解説します。適切なエラーハンドリングを行うことで、安定したアプリケーションを構築できます。

よくあるエラーとその対処法

1. **進捗バーの並行処理で競合が発生する**

複数のスレッドで進捗バーを更新する場合、表示が乱れることがあります。MultiProgressを使用して複数の進捗バーを管理しましょう。

問題の例：

use indicatif::ProgressBar;
use std::thread;
use std::time::Duration;

fn main() {
    let pb = ProgressBar::new(100);

    let handle = thread::spawn(move || {
        for _ in 0..100 {
            pb.inc(1);
            thread::sleep(Duration::from_millis(10));
        }
        pb.finish_with_message("完了");
    });

    handle.join().unwrap();
}

解決方法：

use indicatif::{MultiProgress, ProgressBar};
use std::thread;
use std::time::Duration;

fn main() {
    let multi = MultiProgress::new();
    let pb = multi.add(ProgressBar::new(100));

    let handle = thread::spawn(move || {
        for _ in 0..100 {
            pb.inc(1);
            thread::sleep(Duration::from_millis(10));
        }
        pb.finish_with_message("完了");
    });

    multi.join().unwrap();
    handle.join().unwrap();
}

2. **`template`や`style`の設定ミス**

進捗バーのテンプレートやスタイル設定で、無効なフォーマットを指定するとパニックが発生します。

問題の例：

let style = ProgressStyle::default_bar()
    .template("{invalid_placeholder}") // 存在しないプレースホルダ
    .unwrap();

解決方法：

有効なプレースホルダを確認し、正しいテンプレートを設定します。

let style = ProgressStyle::default_bar()
    .template("{bar:40} {pos}/{len} ({eta})")
    .unwrap();

3. **進捗バーが最後まで更新されない**

ループ内で適切にbar.inc()を呼ばないと、進捗バーが期待通りに進まないことがあります。

問題の例：

let bar = ProgressBar::new(100);
for _ in 0..50 {
    // `bar.inc(1)`が呼ばれていない
    thread::sleep(Duration::from_millis(50));
}
bar.finish_with_message("完了");

解決方法：

ループごとにbar.inc()を呼んで進捗を更新します。

let bar = ProgressBar::new(100);
for _ in 0..50 {
    bar.inc(2); // 2ずつ増やして合計100に到達
    thread::sleep(Duration::from_millis(50));
}
bar.finish_with_message("完了");

エラーハンドリングの例

ネットワークやファイル操作などのタスクで進捗バーを使う場合、エラー処理を追加することが重要です。

use indicatif::ProgressBar;
use std::fs::File;
use std::io::{self, Write};
use std::thread;
use std::time::Duration;

fn write_to_file(path: &str, content: &str) -> io::Result<()> {
    let bar = ProgressBar::new(content.len() as u64);

    let mut file = File::create(path)?;
    for (i, c) in content.chars().enumerate() {
        file.write_all(&[c as u8])?;
        bar.inc(1);
        thread::sleep(Duration::from_millis(10));
    }

    bar.finish_with_message("ファイル書き込み完了！");
    Ok(())
}

fn main() {
    if let Err(e) = write_to_file("output.txt", "Hello, world!") {
        eprintln!("エラーが発生しました: {}", e);
    }
}

解説

  • ?演算子：ファイル操作中にエラーが発生した場合、エラーを呼び出し元に伝播します。
  • エラーメッセージの出力：eprintln!でエラー内容を表示します。

トラブルシューティングのポイント

  1. 進捗バーが更新されない場合
  • bar.inc()やbar.set_position()が正しく呼ばれているか確認しましょう。
  1. 表示が乱れる場合
  • 複数のスレッドで進捗バーを使用する際はMultiProgressを利用しましょう。
  1. エラー内容が分からない場合
  • エラー出力やデバッグ用のメッセージを追加して問題箇所を特定しましょう。

これらのエラーハンドリングとトラブルシューティングを適用することで、indicatifを使った進捗バーの実装をより堅牢にすることができます。

まとめ

本記事では、Rustで進捗バーを実装する方法としてindicatifクレートの使い方を解説しました。基本的な進捗バーの導入から、複数の進捗バーの管理、スピナーを使ったローディングアニメーション、進捗バーのカスタマイズ方法、そしてエラーハンドリングとトラブルシューティングまで、実践的な内容を紹介しました。

indicatifを活用することで、タスクの進行状況を視覚的に示し、ユーザー体験を向上させることができます。ファイルダウンロード、大規模データ処理、バックアップ処理など、さまざまなシーンで役立てることが可能です。

適切なカスタマイズとエラー処理を加えることで、信頼性と使いやすさを兼ね備えたアプリケーションを構築しましょう。Rustのプロジェクトにindicatifを導入して、進捗状況の可視化に挑戦してみてください！

Rust
プログラミング Rust 進捗バー indicatif

コメント

コメントする

目次