Rust终端微调动画库spinoff使用指南

spinoff是一个轻量级的Rust库，用于在命令行界面中创建美观的进度条和状态指示器。它特别适合需要长时间运行的任务，为用户提供视觉反馈。

安装

在Cargo.toml中添加依赖：

[dependencies]
spinoff = "0.7"

基本用法

创建简单的旋转器

use spinoff::{Spinner, spinners};

fn main() {
    let spinner = Spinner::new(spinners::Dots, "Loading...", None);
    
    // 模拟耗时任务
    std::thread::sleep(std::time::Duration::from_secs(3));
    
    spinner.success("Task completed!");
}

可用的旋转器类型

spinoff提供了多种内置的旋转器样式：

use spinoff::{Spinner, spinners};

let spinner = Spinner::new(spinners::Dots, "Dots spinner", None);
// 或
let spinner = Spinner::new(spinners::Line, "Line spinner", None);
// 或
let spinner = Spinner::new(spinners::Bounce, "Bounce spinner", None);

高级用法

自定义颜色

use spinoff::{Spinner, spinners, Color};

let spinner = Spinner::new(
    spinners::Arc, 
    "Colored spinner", 
    Some(Color::Blue)
);

更新消息

use spinoff::{Spinner, spinners};

let mut spinner = Spinner::new(spinners::Bounce, "Initial message", None);

// 模拟任务进度
std::thread::sleep(std::time::Duration::from_secs(1));
spinner.update("Processing step 1...");

std::thread::sleep(std::time::Duration::from_secs(1));
spinner.update("Processing step 2...");

结束状态

use spinoff::{Spinner, spinners};

let spinner = Spinner::new(spinners::Dots, "Working...", None);

// 任务完成后可以设置不同的结束状态
spinner.success("Success!");  // 绿色√
// 或
spinner.fail("Failed!");     // 红色×
// 或
spinner.warn("Warning!");    // 黄色!
// 或
spinner.clear();            // 直接清除

自定义字符旋转器

use spinoff::{Spinner, spinners};

let custom_frames = vec!["⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏"];
let spinner = Spinner::new_with_stream(custom_frames, "Custom spinner", None);

进度条功能

spinoff也可以创建简单的进度条：

use spinoff::{Spinner, spinners};

let mut spinner = Spinner::new(spinners::Bar, "Downloading...", None);

for i in 0..=100 {
    spinner.update_text(&format!("Downloading... {}%", i));
    std::thread::sleep(std::time::Duration::from_millis(50));
}

spinner.success("Download complete!");

注意事项

1. 确保在程序退出前调用success、fail、warn或clear方法，否则旋转器可能会留在终端中
2. 在多线程环境中使用时，确保对Spinner实例的访问是线程安全的
3. 某些终端可能不支持所有颜色或动画效果

完整示例DEMO

下面是一个综合使用spinoff各种功能的完整示例：

use spinoff::{Spinner, spinners, Color};
use std::thread;
use std::time::Duration;

fn main() {
    // 1. 基本旋转器示例
    let spinner1 = Spinner::new(spinners::Dots, "正在加载基础数据...", None);
    thread::sleep(Duration::from_secs(2));
    spinner1.success("基础数据加载完成！");

    // 2. 带颜色的旋转器
    let spinner2 = Spinner::new(
        spinners::Line,
        "正在处理彩色任务...",
        Some(Color::Green)
    );
    thread::sleep(Duration::from_secs(2));
    spinner2.success("彩色任务完成！");

    // 3. 更新消息的旋转器
    let mut spinner3 = Spinner::new(spinners::Bounce, "初始化处理...", None);
    thread::sleep(Duration::from_secs(1));
    spinner3.update("处理第一阶段...");
    thread::sleep(Duration::from_secs(1));
    spinner3.update("处理第二阶段...");
    thread::sleep(Duration::from_secs(1));
    spinner3.success("多阶段处理完成！");

    // 4. 自定义帧动画旋转器
    let custom_frames = vec!["⣾", "⣽", "⣻", "⢿", "⡿", "⣟", "⣯", "⣷"];
    let spinner4 = Spinner::new_with_stream(custom_frames, "自定义动画处理中...", None);
    thread::sleep(Duration::from_secs(2));
    spinner4.clear();

    // 5. 进度条示例
    let mut spinner5 = Spinner::new(spinners::Bar, "文件下载进度:", None);
    for i in 0..=100 {
        if i % 10 == 0 {
            spinner5.update_text(&format!("文件下载进度: {}%", i));
        }
        thread::sleep(Duration::from_millis(50));
    }
    spinner5.success("文件下载完成！");

    // 6. 失败状态示例
    let spinner6 = Spinner::new(spinners::Arc, "危险操作中...", None);
    thread::sleep(Duration::from_secs(1));
    spinner6.fail("操作失败！");
}