process_control 0.2.0

Methods for terminating processes without requiring unique access.
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

# Process Control

This crate allows terminating a process without a mutable reference. Thus, it
becomes possible to abort early from waiting for output or an exit code –
primarily through [`ProcessTerminator::terminate`]. That method is
intentionally designed to not require a reference of any kind to the [`Child`]
instance, to allow for maximal flexibility.

Typically, it is not possible to terminate a process during a call to
[`Child::wait`] or [`Child::wait_with_output`] in another thread, since
[`Child::kill`] takes a mutable reference. However, since this crate creates
its own termination method, there is no issue, and useful methods such as
[`Terminator::wait_for_output_with_timeout`] can exist.

[![GitHub Build Status](https://github.com/dylni/process_control/workflows/build/badge.svg?branch=master)](https://github.com/dylni/process_control/actions?query=branch%3Amaster)

## Usage

Add the following lines to your "Cargo.toml" file:

```toml
[dependencies]
process_control = "0.2"
```

See the [documentation] for available functionality and examples.

## Rust version support

The minimum supported Rust toolchain version is currently Rust 1.34.0.

## License

Licensing terms are specified in [COPYRIGHT].

Unless you explicitly state otherwise, any contribution submitted for inclusion
in this crate, as defined in [LICENSE-APACHE], shall be licensed according to
[COPYRIGHT], without any additional terms or conditions.

[`Child`]: https://doc.rust-lang.org/std/process/struct.Child.html
[`Child::kill`]: https://doc.rust-lang.org/std/process/struct.Child.html#method.kill
[`Child::wait`]: https://doc.rust-lang.org/std/process/struct.Child.html#method.wait
[`Child::wait_with_output`]: https://doc.rust-lang.org/std/process/struct.Child.html#method.wait_with_output
[COPYRIGHT]: https://github.com/dylni/process_control/blob/master/COPYRIGHT
[documentation]: https://docs.rs/process_control
[LICENSE-APACHE]: https://github.com/dylni/process_control/blob/master/LICENSE-APACHE
[`ProcessTerminator::terminate`]: https://docs.rs/process_control/0.2.0/process_control/struct.ProcessTerminator.html#method.terminate
[sealed]: https://rust-lang.github.io/api-guidelines/future-proofing.html#c-sealed
[`Terminator::wait_for_output_with_timeout`]: https://docs.rs/process_control/0.2.0/process_control/trait.Terminator.html#tymethod.wait_with_timeout