cmd-proc 0.6.0

Process command builder with capture 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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

# Changelog

## 0.6.0

### Breaking Changes

- `EnvVariableName` no longer has a lifetime parameter. Public constructors only
  produced `EnvVariableName<'static>` in practice; the `<'a>` was unused. Replace
  `cmd_proc::EnvVariableName<'static>` with `cmd_proc::EnvVariableName` at call
  sites; `from_static_or_panic` and `FromStr` are unchanged.

### Added

- `EnvVariableValue` — validated environment variable value (no NUL bytes; byte
  length capped at `ENV_VARIABLE_VALUE_MAX_LEN` = `u16::MAX`). Mirrors the
  `EnvVariableName` shape: `Cow<'static, str>` internally with
  `from_static_or_panic` for compile-time-validated literals and
  `FromStr` / `TryFrom<String>` for runtime values.
- `EnvVariableValueError` — `ContainsNul { index }` and `TooLong { length, max }`
  variants.
- `ENV_VARIABLE_VALUE_MAX_LEN` public constant.

## 0.5.0

### Breaking Changes

- `CommandError` is now an enum that distinguishes IO failures from non-zero exit
  statuses: the `Io(std::io::Error)` variant covers spawn, wait, and stream read
  failures, while the `ExitStatus(std::process::ExitStatus)` variant covers
  commands that ran but exited non-zero. Previously both failure modes were
  represented by a single struct with two `Option` fields, forcing every caller
  to inspect both to figure out what went wrong.
- `CommandError`'s `Display` no longer prints a debug dump of its fields; each
  variant has its own readable message, and `Io` exposes the underlying
  `std::io::Error` via `source()` so error-chain walkers print a proper cause.

## 0.4.0

### Breaking Changes

- Typestate stream handling API: `Command::capture_stdout()` renamed to `Command::stdout_capture()`,
  `Command::capture_stderr()` renamed to `Command::stderr_capture()`
- Remove `Command::capture_stderr_stdout()` (use `.stdout_capture().stderr_capture()` instead)
- Remove `Command::output()` (use `.stdout_capture().stderr_capture().run()` instead)
- Replace `Capture` with `CaptureSingle<S>` using sealed `StreamMarker` trait (`Stdout`/`Stderr`)
- Replace `CaptureAllStreams` with `CaptureAll`
- Replace `Output` with `CaptureAllResult` (fields: `stdout`, `stderr`, `status`)
- Add `CaptureSingleResult` (fields: `bytes`, `status`)
- Remove `Output::success()`, `Output::into_stdout_string()`, `Output::into_stderr_string()`
- Remove `Spawn` builder, `Stdio` enum, `Child` struct
- Remove `Command::spawn()` (use `.build()` for native `tokio::process` access)

### Added

- `Command::stdout_null()`, `Command::stderr_null()` to redirect streams to /dev/null
- `Command::stdout_inherit()`, `Command::stderr_inherit()` for explicit inherit
- Bidirectional typestate transitions: `CaptureAll` -> `CaptureSingle<S>` -> `Command`
- `CaptureSingle<S>::run()` returning `CaptureSingleResult`
- `CaptureAll::run()` returning `CaptureAllResult`
- `Command::build()` to access the underlying `tokio::process::Command`

## 0.3.0

### Breaking Changes

- Switch from `std::process` to `tokio::process` for async process execution
- `Command::status()`, `Command::output()` are now `async fn`
- `Capture::bytes()`, `Capture::string()` are now `async fn`
- `CaptureAllStreams::output()` is now `async fn`
- `Child::wait()`, `Child::wait_with_output()` are now `async fn`
- `Child` stream accessors now return `tokio::process` types
- `Spawn` doc example uses `tokio::io::AsyncBufReadExt` instead of `std::io::BufRead`

### Added

- `tokio` dependency with `process` and `io-util` features

## 0.2.0

### Breaking Changes

- Rename `Command::stdout()` to `Command::capture_stdout()`
- Rename `Command::stderr()` to `Command::capture_stderr()`
- Rename internal `CaptureStream` to `CaptureSingleStream`

### Added

- `Command::capture_stderr_stdout()` method returning `CaptureAllStreams` for capturing both streams
- `Capture::accept_nonzero_exit()` to allow non-zero exit codes without error
- `CaptureAllStreams::accept_nonzero_exit()` to allow non-zero exit codes without error

### Changed

- `Capture` now only pipes the targeted stream; the other stream inherits to the terminal instead of being silently discarded

## 0.1.0

### Breaking Changes

- Rename `EnvVariableName::from_static` to `from_static_or_panic`

### Added

- `Display` implementation for `EnvVariableName`
- `PartialOrd` and `Ord` derives for `EnvVariableName`

### Fixed

- `env` and `envs` methods now require `EnvVariableName` instead of raw strings, enforcing validation

## 0.0.1

- Initial release