Skip to main content

crumbkit_process/
lib.rs

1// The crate docs are the README, so its example runs as a doctest. The README
2// links to files in the repository, which work on GitHub. The definitions below
3// come first, so rustdoc uses them for the same labels (ADR-0013).
4//! [`run`]: crate::run()
5//! [`RunOptions`]: crate::RunOptions
6//! [`Escalation`]: crate::Escalation
7//! [`line_queue`]: crate::line_queue
8//! [`forward`]: https://github.com/crumbkit/crumbkit/blob/main/crates/crumbkit-process/src/forward.rs
9//! [`Outcome`]: crate::Outcome
10//! [ADR-0171]: https://github.com/crumbkit/crumbkit/blob/main/docs/decisions/api/processes/0171-the-process-crate.md
11//! [ADR-0172]: https://github.com/crumbkit/crumbkit/blob/main/docs/decisions/api/processes/0172-process-crate-additions.md
12//! [ADR-0174]: https://github.com/crumbkit/crumbkit/blob/main/docs/decisions/api/processes/0174-stopped-run-keeps-child-status.md
13//! [processes docs]: https://github.com/crumbkit/crumbkit/blob/main/docs/behaviour/processes.md
14#![doc = include_str!("../README.md")]
15
16mod cancel;
17mod escalation;
18#[cfg(all(unix, feature = "forward"))]
19pub mod forward;
20mod group;
21mod lines;
22mod notice;
23mod outcome;
24mod run;
25mod sys;
26#[cfg(test)]
27mod testing;
28
29pub use self::cancel::Cancel;
30pub use self::escalation::Escalation;
31pub(crate) use self::group::Group;
32pub use self::group::{Scope, Signal};
33pub use self::lines::{LineQueue, Lines, Silent, line_queue};
34pub use zeroize::Zeroizing;
35
36pub use self::outcome::{Outcome, Status, StopReason};
37pub use self::run::{
38    Capture, Captured, ChildFinished, DRAIN_GRACE, Input, LongLine, OverLimit, REAP_GRACE,
39    RunError, RunOptions, Spawn, Spawned, run,
40};