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 overdue;
25mod run;
26mod sys;
27#[cfg(test)]
28mod testing;
29
30pub use self::cancel::Cancel;
31pub use self::escalation::Escalation;
32pub(crate) use self::group::Group;
33pub use self::group::{Scope, Signal};
34pub use self::lines::{LineQueue, Lines, Silent, line_queue};
35pub use zeroize::Zeroizing;
36
37pub use self::outcome::{Outcome, Status, StopReason};
38pub use self::overdue::Overdue;
39pub use self::run::{
40    Capture, Captured, ChildFinished, DRAIN_GRACE, Input, LineCapture, LongLine, OverLimit,
41    REAP_GRACE, RunError, RunOptions, Spawn, Spawned, WholeCapture, run,
42};