Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tamschi/mirror-mask
A scoped signal forwarder.
https://github.com/tamschi/mirror-mask
rust signal unix
Last synced: about 1 month ago
JSON representation
A scoped signal forwarder.
- Host: GitHub
- URL: https://github.com/tamschi/mirror-mask
- Owner: Tamschi
- License: other
- Created: 2021-10-02T18:12:44.000Z (over 3 years ago)
- Default Branch: develop
- Last Pushed: 2024-04-15T05:53:59.000Z (9 months ago)
- Last Synced: 2024-05-02T01:06:35.312Z (8 months ago)
- Topics: rust, signal, unix
- Language: Rust
- Homepage:
- Size: 152 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE-APACHE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# mirror-mask
[](https://lib.rs/crates/mirror-mask)
[](https://crates.io/crates/mirror-mask)
[](https://docs.rs/mirror-mask)
[](https://github.com/Tamschi/mirror-mask/actions?query=workflow%3ACI+branch%3Adevelop)
[](https://github.com/Tamschi/mirror-mask)
[](https://github.com/Tamschi/mirror-mask/issues)
[](https://github.com/Tamschi/mirror-mask/pulls)
[](https://github.com/Tamschi/mirror-mask/contribute)
[](https://web.crev.dev/rust-reviews/crate/mirror-mask/)
A scoped signal deflector.
(Unrelated to the 2005 fantasy film of similar name.)
Current operating system support: Unix (via the `nix` crate).
The crate otherwise compiles without function,
unless the `"required"` feature (active by default) is active.
## Installation
Please use [cargo-edit](https://crates.io/crates/cargo-edit) to always add the latest version of this library:
```cmd
cargo add mirror-mask
```
If your program does not rely on `mirror-mask` for correctness,
you can allow it to compile without function for unsupported targets.
```cmd
cargo add mirror-mask --no-default-features
```
## Example
```rust
let mut child = std::process::Command
::new("ping")
.args(["example.com", "-c", "3"])
.spawn().unwrap();
{
let _relay_guard = mirror_mask::Intent::InterruptFromKeyboard.relay_to_child(&child); // <--
child.wait().ok(); // Press Ctrl-c about here.
}
println!("Still alive!");
```
## License
Licensed under either of
- Apache License, Version 2.0
([LICENSE-APACHE](LICENSE-APACHE) or )
- MIT license
([LICENSE-MIT](LICENSE-MIT) or )
at your option.
## Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.
See [CONTRIBUTING](CONTRIBUTING.md) for more information.
### Interactive Testing
Run
```bash
cargo run --all-features
```
or
```bash
cargo run --all-features -- -r
```
and press (with `-r`/`--recursive` repeatedly Enter and then) Ctrl+c.
The program should exit gracefully.
## [Code of Conduct](CODE_OF_CONDUCT.md)
## [Changelog](CHANGELOG.md)
## Versioning
`mirror-mask` strictly follows [Semantic Versioning 2.0.0](https://semver.org/spec/v2.0.0.html) with the following exceptions:
- The minor version will not reset to 0 on major version changes (except for v1).
Consider it the global feature level.
- The patch version will not reset to 0 on major or minor version changes (except for v0.1 and v1).
Consider it the global patch level.
This includes the Rust version requirement specified above.
Earlier Rust versions may be compatible, but this can change with minor or patch releases.
Which versions are affected by features and patches can be determined from the respective headings in [CHANGELOG.md](CHANGELOG.md).
Note that dependencies of this crate may have a more lenient MSRV policy!
Please use `cargo +nightly update -Z minimal-versions` in your automation if you don't generate Cargo.lock manually (or as necessary) and require support for a compiler older than current stable.