shipper 0.3.0-rc.1

Core library for reliable, resumable Rust workspace publishing
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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68

//! Result types for process execution.

use std::process::Output;
use std::time::Duration;

use anyhow::Result;
use serde::{Deserialize, Serialize};

/// Result of a command execution.
#[allow(dead_code)]
#[derive(Debug, Clone, Serialize, Deserialize)]
pub(crate) struct CommandResult {
    /// Whether the command succeeded (exit code 0).
    pub(crate) success: bool,
    /// Exit code (if available).
    pub(crate) exit_code: Option<i32>,
    /// Standard output.
    pub(crate) stdout: String,
    /// Standard error.
    pub(crate) stderr: String,
    /// Duration of execution.
    pub(crate) duration_ms: u64,
}

impl CommandResult {
    /// Check if the command succeeded.
    #[allow(dead_code)]
    pub(crate) fn ok(&self) -> Result<&Self> {
        if self.success {
            Ok(self)
        } else {
            Err(anyhow::anyhow!(
                "command failed with exit code {:?}: {}",
                self.exit_code,
                self.stderr
            ))
        }
    }

    /// Create a result from a process output.
    #[allow(dead_code)]
    pub(crate) fn from_output(output: &Output, duration: Duration) -> Self {
        Self {
            success: output.status.success(),
            exit_code: output.status.code(),
            stdout: String::from_utf8_lossy(&output.stdout).to_string(),
            stderr: String::from_utf8_lossy(&output.stderr).to_string(),
            duration_ms: duration.as_millis() as u64,
        }
    }
}

/// Result of a command execution with timeout bookkeeping.
#[allow(dead_code)]
#[derive(Debug, Clone, Serialize, Deserialize)]
pub(crate) struct CommandOutput {
    /// Exit code (or -1 when not available).
    pub(crate) exit_code: i32,
    /// Captured stdout.
    pub(crate) stdout: String,
    /// Captured stderr.
    pub(crate) stderr: String,
    /// Whether execution exceeded timeout.
    pub(crate) timed_out: bool,
    /// Total wall-clock duration.
    #[allow(dead_code)]
    pub(crate) duration: Duration,
}