Rust PowerShell脚本执行库 powershell_script 使用指南

powershell_script 是一个 Rust 库，允许开发者在 Rust 程序中无缝执行和管理 PowerShell 命令与脚本。它提供了简单易用的 API 来运行 PowerShell 命令并获取结果。

安装

在 Cargo.toml 中添加依赖：

[dependencies]
powershell_script = "1.0"

基本用法

执行简单命令

use powershell_script::PsScriptBuilder;

fn main() {
    // 定义要执行的PowerShell命令
    let cmd = "Get-Process | Select-Object -First 3";
    
    // 构建并执行PowerShell脚本
    let output = PsScriptBuilder::new()
        .no_profile(true)       // 不加载用户配置文件
        .non_interactive(true)  // 非交互模式
        .hidden(false)          // 不隐藏窗口
        .print_commands(false)  // 不打印执行的命令
        .build()
        .run(cmd)
        .unwrap();
    
    // 输出执行结果
    println!("Status: {}", output.status.success());
    println!("Stdout: {}", output.stdout());
    println!("Stderr: {}", output.stderr());
}

执行脚本文件

use powershell_script::PsScriptBuilder;

fn main() {
    // 执行指定的PowerShell脚本文件
    let output = PsScriptBuilder::new()
        .run_from_file("script.ps1")
        .unwrap();
    
    // 输出脚本执行结果
    println!("Script output: {}", output.stdout());
}

高级功能

传递参数

use powershell_script::{PsScriptBuilder, EscapePowerShellArg};

fn main() {
    // 安全转义参数
    let param1 = "Hello".escape_powershell_arg();
    let param2 = "World".escape_powershell_arg();
    
    // 构建带参数的PowerShell命令
    let cmd = format!("param($p1, $p2) Write-Output \"$p1 $p2\" -args {}, {}", param1, param2);
    
    // 执行命令
    let output = PsScriptBuilder::new()
        .run(&cmd)
        .unwrap();
    
    println!("Output: {}", output.stdout());
}

异步执行

use powershell_script::PsScriptBuilder;
use tokio::runtime::Runtime;

fn main() {
    // 创建Tokio运行时
    let rt = Runtime::new().unwrap();
    
    // 异步执行PowerShell命令
    let output = rt.block_on(async {
        PsScriptBuilder::new()
            .run_async("Get-Service | Where-Object { $_.Status -eq 'Running' }")
            .await
    }).unwrap();
    
    println!("Running services:\n{}", output.stdout());
}

处理二进制输出

use powershell_script::PsScriptBuilder;

fn main() {
    // 执行生成二进制数据的命令
    let output = PsScriptBuilder::new()
        .run("[System.Text.Encoding]::UTF8.GetBytes('Binary data')")
        .unwrap();
    
    // 获取二进制输出
    let binary_data = output.stdout_bytes();
    println!("Binary data length: {}", binary_data.len());
}

错误处理

use powershell_script::{PsScriptBuilder, PowerShellError};

fn main() -> Result<(), PowerShellError> {
    // 尝试执行不存在的命令
    let output = PsScriptBuilder::new()
        .run("This-Command-Does-Not-Exist")?;
    
    // 检查命令是否执行成功
    if !output.status.success() {
        eprintln!("PowerShell error: {}", output.stderr());
    }
    
    Ok(())
}

完整示例

下面是一个结合了多个功能的完整示例：

use powershell_script::{PsScriptBuilder, EscapePowerShellArg};
use tokio::runtime::Runtime;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // 示例1: 执行简单命令
    println!("=== 示例1: 执行简单命令 ===");
    let cmd = "Get-ChildItem | Select-Object -First 5";
    let output = PsScriptBuilder::new()
        .no_profile(true)
        .non_interactive(true)
        .run(cmd)?;
    println!("Command output:\n{}", output.stdout());

    // 示例2: 传递参数
    println!("\n=== 示例2: 传递参数 ===");
    let user = "Admin".escape_powershell_arg();
    let message = "Welcome!".escape_powershell_arg();
    let param_cmd = format!(
        "param($user, $msg) Write-Output \"User: $user, Message: $msg\" -args {}, {}",
        user, message
    );
    let param_output = PsScriptBuilder::new().run(&param_cmd)?;
    println!("Parameter output: {}", param_output.stdout());

    // 示例3: 异步执行
    println!("\n=== 示例3: 异步执行 ===");
    let rt = Runtime::new()?;
    let async_output = rt.block_on(async {
        PsScriptBuilder::new()
            .run_async("Get-Date -Format 'yyyy-MM-dd HH:mm:ss'")
            .await
    })?;
    println!("Current date: {}", async_output.stdout());

    // 示例4: 错误处理
    println!("\n=== 示例4: 错误处理 ===");
    match PsScriptBuilder::new().run("Non-Existent-Cmdlet") {
        Ok(output) => {
            if !output.status.success() {
                println!("Command failed with error: {}", output.stderr());
            }
        }
        Err(e) => println!("Execution error: {}", e),
    }

    Ok(())
}

注意事项

1. 在 Windows 上需要安装 PowerShell
2. 在非 Windows 平台上需要安装 PowerShell Core (pwsh)
3. 对于敏感命令，考虑使用 .hidden(true) 来隐藏 PowerShell 窗口
4. 使用 .escape_powershell_arg() 方法来安全地传递参数，防止注入攻击

这个库为 Rust 和 PowerShell 之间的互操作提供了强大的支持，特别适合需要在 Rust 应用中集成 Windows 管理功能的场景。