proc-result 0.3.0

A tiny cross-platform library containing exit status and code types
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

# proc-result

A tiny cross-platform library containing exit status and code types.

[![Rust](https://github.com/crates-lurey-io/proc-result/actions/workflows/rust.yml/badge.svg)](https://github.com/crates-lurey-io/proc-result/actions/workflows/rust.yml)
[![Docs](https://github.com/crates-lurey-io/proc-result/actions/workflows/docs.yml/badge.svg)](https://github.com/crates-lurey-io/proc-result/actions/workflows/docs.yml)
[![Crates.io Version](https://img.shields.io/crates/v/proc-result)](https://crates.io/crates/proc-result)
[![codecov](https://codecov.io/gh/crates-lurey-io/proc-result/graph/badge.svg?token=Z3VUWA3WYY)](https://codecov.io/gh/crates-lurey-io/proc-result)

Unlike `std::process`, this crate does not require the standard library[^1], nor
`libc`, and can create and interpret exit codes of non-current platforms. For
example, on Windows, it can read and interpret exit codes that may have been
recorded from a Linux process, or vice versa.

[^1]: The `std` feature is enabled by default, but can be disabled.

## Usage

Most users of the crate will use the `ProcResult` enum, which represents the
result a run of a explaining what exit code or (on Unix platforms) the signal
the subprocess was prematurely terminated with, and is constructed from a
`std::process::ExitStatus`:

```rust
use proc_result::ProcResult;
use std::error::Error;
use std::process::Command;

fn main() -> Result<(), Box<dyn Error>> {
    let result: ProcResult = Command::new("ls").status()?.into();

    // Ensures exit code 0.
    result.ok()?;

    Ok(())
}
```

Advanced users, or users writing tests or interpreting exit codes from other
platforms may import and use the platform-specific exit code types directly,
from the `unix` or `windows` modules, respectively. For example, to create a
Unix exit code from a raw integer:

```rust
use proc_result::unix::ExitCode;

let code = ExitCode::from_raw(1);
if code.is_success() {
    println!("Command succeeded!");
} else {
    eprintln!("Command failed with exit code: {}", code);
}
```

## Features

Name    | Default | Description
------- | ------- | -----------
`serde` | `false` | Enables serialization support for most types using `serde`.
`std`   | `true`  | Enables compatibility with `std::process::ExitStatus`.