tokio-process-tools 0.11.0

Correctness-focused async subprocess orchestration for Tokio: bounded output, multi-consumer streams, output detection, guaranteed cleanup and graceful termination.
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

use crate::{LineCollectionOptions, RawCollectionOptions};
use std::time::Duration;

/// Default grace period for output consumers to observe EOF after process termination.
pub const DEFAULT_OUTPUT_EOF_TIMEOUT: Duration = Duration::from_secs(3);

/// Options for line output collection from stdout and stderr.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct LineOutputOptions {
    /// Collection options used for stdout.
    pub stdout_collection_options: LineCollectionOptions,

    /// Collection options used for stderr.
    pub stderr_collection_options: LineCollectionOptions,
}

impl LineOutputOptions {
    /// Use the same [`LineCollectionOptions`] for both stdout and stderr.
    #[must_use]
    pub const fn symmetric(options: LineCollectionOptions) -> Self {
        Self {
            stdout_collection_options: options,
            stderr_collection_options: options,
        }
    }
}

/// Options for raw byte output collection from stdout and stderr.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct RawOutputOptions {
    /// Collection options used for stdout.
    pub stdout_collection_options: RawCollectionOptions,

    /// Collection options used for stderr.
    pub stderr_collection_options: RawCollectionOptions,
}

impl RawOutputOptions {
    /// Use the same [`RawCollectionOptions`] for both stdout and stderr.
    #[must_use]
    pub const fn symmetric(options: RawCollectionOptions) -> Self {
        Self {
            stdout_collection_options: options,
            stderr_collection_options: options,
        }
    }
}