Struct grep_cli::CommandReaderBuilder [−][src]
pub struct CommandReaderBuilder { /* fields omitted */ }
Configures and builds a streaming reader for process output.
Methods
impl CommandReaderBuilder
[src]
impl CommandReaderBuilder
pub fn new() -> CommandReaderBuilder
[src]
pub fn new() -> CommandReaderBuilder
Create a new builder with the default configuration.
pub fn build(
&self,
command: &mut Command
) -> Result<CommandReader, CommandError>
[src]
pub fn build(
&self,
command: &mut Command
) -> Result<CommandReader, CommandError>
Build a new streaming reader for the given command's output.
The caller should set everything that's required on the given command before building a reader, such as its arguments, environment and current working directory. Settings such as the stdout and stderr (but not stdin) pipes will be overridden so that they can be controlled by the reader.
If there was a problem spawning the given command, then its error is returned.
pub fn async_stderr(&mut self, yes: bool) -> &mut CommandReaderBuilder
[src]
pub fn async_stderr(&mut self, yes: bool) -> &mut CommandReaderBuilder
When enabled, the reader will asynchronously read the contents of the command's stderr output. When disabled, stderr is only read after the stdout stream has been exhausted (or if the process quits with an error code).
Note that when enabled, this may require launching an additional thread in order to read stderr. This is done so that the process being executed is never blocked from writing to stdout or stderr. If this is disabled, then it is possible for the process to fill up the stderr buffer and deadlock.
This is enabled by default.
Trait Implementations
impl Clone for CommandReaderBuilder
[src]
impl Clone for CommandReaderBuilder
fn clone(&self) -> CommandReaderBuilder
[src]
fn clone(&self) -> CommandReaderBuilder
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
impl Debug for CommandReaderBuilder
[src]
impl Debug for CommandReaderBuilder
fn fmt(&self, f: &mut Formatter) -> Result
[src]
fn fmt(&self, f: &mut Formatter) -> Result
Formats the value using the given formatter. Read more
impl Default for CommandReaderBuilder
[src]
impl Default for CommandReaderBuilder
fn default() -> CommandReaderBuilder
[src]
fn default() -> CommandReaderBuilder
Returns the "default value" for a type. Read more
Auto Trait Implementations
impl Send for CommandReaderBuilder
impl Send for CommandReaderBuilder
impl Sync for CommandReaderBuilder
impl Sync for CommandReaderBuilder