Struct StreamOptions 

#[non_exhaustive]
pub struct StreamOptions {
    pub timeout: Option<Duration>,
    pub poll: Duration,
    pub stdout_tail_cap: usize,
    pub stderr_tail_cap: usize,
    pub no_window: bool,
    pub input: Option<Vec<u8>>,
}

Limits and options for run_streaming. Build one with StreamOptions::new (or Default) and the builder methods; the struct is #[non_exhaustive], so later options do not break callers.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

timeout: Option<Duration>

How long the program may run before its tree is terminated. None (the default) is no deadline: only the child’s exit or the cancel predicate ends the call.

poll: Duration

The longest the call goes without evaluating the cancel predicate and the deadline (default 100 ms). The predicate is evaluated at least this often, however much output is flowing. Values under 1 ms behave as 1 ms.

stdout_tail_cap: usize

Most bytes of stdout kept in StreamOutput::stdout_tail: the last ones (default 64 KiB).

stderr_tail_cap: usize

Most bytes of stderr kept in StreamOutput::stderr_tail: the last ones (default 64 KiB).

no_window: bool

Hide the console window on Windows. The default. false leaves it visible.

input: Option<Vec<u8>>

Bytes written to the child’s stdin, then EOF. None (the default) gives it a null stdin.

Implementations

impl StreamOptions

pub fn new() -> Self

No deadline, a 100 ms poll, 64 KiB tails, no window, null stdin.

pub fn timeout(self, timeout: Duration) -> Self

pub fn poll(self, poll: Duration) -> Self

pub fn stdout_tail_cap(self, bytes: usize) -> Self

pub fn stderr_tail_cap(self, bytes: usize) -> Self

pub fn no_window(self, hidden: bool) -> Self

pub fn input(self, bytes: impl Into<Vec<u8>>) -> Self

Trait Implementations

impl Clone for StreamOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StreamOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for StreamOptions

fn default() -> Self

Returns the “default value” for a type.

impl Eq for StreamOptions

impl PartialEq for StreamOptions

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for StreamOptions