Struct CommandPipe

Source

pub struct CommandPipe { /* private fields */ }

Expand description

A type representing an anonymous pipe

Implementations§

Source §

impl CommandPipe

Source

pub fn new() -> Self

Create a new empty pipe.

§Example

let mut pipe = CommandPipe::new();

Source

pub fn add_command<S>(&mut self, c: S) -> &mut Self
where S: AsRef<OsStr>,

Add a command to the pipe.

The command is passed eiter as an absolute path or as a relative path. For relative paths the PATH is checked.

§Example

let mut pipe = CommandPipe::new();
pipe.add_command("ls");

Source

pub fn arg<S>(&mut self, arg: S) -> &mut Self
where S: AsRef<OsStr>,

Add a single argument to the preceding command in the pipe.

Arguments need to be passed one at a time.

§Example

let mut pipe = CommandPipe::new();
pipe.add_command("ls").arg("-la");

Source

pub fn args<I, S>(&mut self, args: I) -> &mut Self
where I: IntoIterator<Item = S>, S: AsRef<OsStr>,

Add multiple arguments to the preceding command in the pipe.

Arguments are passed as a sequence.

§Example

let mut pipe = CommandPipe::new();
pipe.add_command("ls").args(vec!["-la", "~/Documents"]);

Source

pub fn spawn(&mut self) -> Result<(), APipeError>

Runs the commands in the pipe.

§Example

let mut pipe = CommandPipe::new();
pipe.add_command("ls")
    .args(vec!["-la", "~/Documents"])
    .add_command("grep")
    .arg("My_Dir")
    .spawn()
    .expect("Failed to spawn pipe.");

Source

pub fn spawn_with_output(&mut self) -> Result<Output, APipeError>

Spawns all commands in the pipe and returns the Output.

§Example

let output = CommandPipe::new()
    .add_command("echo")
    .arg("This is a test.")
    .add_command("grep")
    .arg("-Eo")
    .arg(r"\w\w\sa[^.]*")
    .spawn_with_output()?;

assert_eq!(output.stdout(), "is a test\n".as_bytes());

Source

pub fn output(&mut self) -> Result<Output, APipeError>

Returns the Output of the pipe.

§Example

let mut pipe = apipe::CommandPipe::new();

pipe.add_command("echo")
    .arg("This is a test.")
    .add_command("grep")
    .arg("-Eo")
    .arg(r"\w\w\sa[^.]*")
    .spawn()
    .expect("Failed to spawn pipe.");
     
let output = pipe.output().unwrap();
     
assert_eq!(output.stdout(), "is a test\n".as_bytes());