ensembler 1.0.0

A library for running commands and reporting progress
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

use thiserror::Error;

use crate::cmd::CmdResult;

/// Errors that can occur when executing commands.
#[derive(Error, Debug)]
#[non_exhaustive]
pub enum Error {
    /// An I/O error occurred (e.g., command not found, permission denied).
    #[error(transparent)]
    Io(#[from] std::io::Error),

    /// Failed to join paths when setting up the command environment.
    #[error(transparent)]
    JoinPaths(#[from] std::env::JoinPathsError),

    /// A Unix-specific error occurred.
    #[cfg(unix)]
    #[error(transparent)]
    Nix(#[from] nix::errno::Errno),

    /// The command exited with a non-zero status code.
    ///
    /// Contains the program name, arguments, combined output, and result.
    #[error("{} exited with non-zero status: {}\n{}", .0.0, render_exit_status(&.0.3), .0.2)]
    ScriptFailed(Box<(String, Vec<String>, String, CmdResult)>),

    /// The command was cancelled via a cancellation token.
    #[error("command was cancelled")]
    Cancelled,

    /// The command timed out.
    #[error("command timed out")]
    TimedOut,

    #[error("internal error: {0}")]
    Internal(String),
}

/// A specialized Result type for ensembler operations.
pub type Result<T> = std::result::Result<T, Error>;

fn render_exit_status(result: &CmdResult) -> String {
    match result.status.code() {
        Some(exit_status) => format!("exit code {exit_status}"),
        None => "no exit status".into(),
    }
}