command-stream 1.5.2

Modern shell command execution library with streaming, async iteration, and event support
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

//! Execa-style exact-argument process execution with a separate options store.
//!
//! Unlike the native shell API, these commands execute a file directly and
//! reject failures by default. Output stays as bytes; `text()` and line helpers
//! provide decoded views. JavaScript-specific IPC and transforms belong to the
//! JavaScript `command-stream/execa` entry point.
//!
//! ```no_run
//! # async fn example() -> Result<(), command_stream::execa::ExecaError> {
//! let result = command_stream::execa("git", ["status", "--short"]).await?;
//! println!("{}", result.text());
//! # Ok(())
//! # }
//! ```

mod command;
mod options;
mod process;
mod result;

pub use command::{Execa, ExecaCommand};
pub use options::{CancelSignal, Cancellation, Options};
pub use process::Subprocess;
pub use result::{ExecaError, ExecaOutcome, ExecaResult};
use std::ffi::OsString;

pub fn execa<P, I, S>(file: P, args: I) -> ExecaCommand
where
    P: Into<OsString>,
    I: IntoIterator<Item = S>,
    S: Into<OsString>,
{
    Execa::default().command(file, args)
}

pub fn execa_sync<P, I, S>(file: P, args: I) -> ExecaOutcome
where
    P: Into<OsString>,
    I: IntoIterator<Item = S>,
    S: Into<OsString>,
{
    execa(file, args).sync()
}

pub fn execa_node<P, I, S>(file: P, args: I) -> ExecaCommand
where
    P: Into<OsString>,
    I: IntoIterator<Item = S>,
    S: Into<OsString>,
{
    Execa::default().node(file, args)
}

pub fn execa_compat(options: Options) -> Execa {
    Execa::new(options)
}