execra 1.1.0

Typed job runtime for Rust apps that wrap external CLI tools: events, interpreters, cancellation, Tauri integration, and optional persistence.
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
69
70
71
72
73
74
75
76

//! The Interpreter contract. See INTERPRETER.md.

use std::time::{Duration, SystemTime};

use crate::command::CommandSpec;
use crate::event::Stream;
use crate::finding::Finding;
use crate::job::JobId;
use crate::outcome::ExitCode;
use crate::phase::Phase;
use crate::progress::Progress;

#[derive(Debug, Clone)]
pub struct Line {
    pub stream: Stream,
    /// Trailing newline already stripped.
    pub text: String,
    pub at: SystemTime,
}

pub struct Context<'a> {
    pub job: JobId,
    pub command: &'a CommandSpec,
    pub current_phase: Option<&'a Phase>,
    pub phase_stack: &'a [Phase],
    pub elapsed: Duration,
}

/// Everything an interpreter is allowed to emit. The runtime translates
/// these into `Event`s, attributing job id, phase id, and timestamps.
#[derive(Debug, Clone)]
pub enum InterpreterEvent {
    EnterPhase {
        name: String,
        label: Option<String>,
    },
    UpdatePhase {
        label: String,
    },
    ExitPhase,

    Progress {
        progress: Progress,
    },
    Label {
        text: String,
    },

    Warning {
        code: Option<String>,
        message: String,
    },
    KnownError {
        code: String,
        message: String,
    },
    Finding {
        finding: Finding,
    },
    Prompt {
        prompt: String,
    },

    Summary {
        text: String,
    },
}

pub trait Interpreter: Send {
    fn on_line(&mut self, ctx: &Context, line: &Line) -> Vec<InterpreterEvent>;

    /// Called exactly once after the process exits and all stdio has drained,
    /// before `Finalized` is emitted. Last chance to flush buffered state or
    /// classify a known error.
    fn on_exit(&mut self, ctx: &Context, exit: &ExitCode) -> Vec<InterpreterEvent>;
}