Struct Shell

pub struct Shell;

The type to spawn commands.

Implementations

impl Shell

pub async fn exec<I, S>( program: &str, args: I, options: &CommandOptions, ) -> Result<ShellExecOutput>

where I: IntoIterator<Item = S>, S: AsRef<OsStr>,

Executes a command as a child process, waiting for it to finish and collecting all of its output. Stdin is ignored.

Examples

use shell_util::{CommandOptions, Shell};
let output =
    Shell::exec("echo", &["Hello!"], &CommandOptions::default())
      .await
      .unwrap();
assert!(output.status.success);
assert_eq!(output.stdout.as_str().unwrap(), "Hello!");

pub async fn status<I, S>( &self, program: &str, args: I, options: &CommandOptions, ) -> Result<ExitStatus>

where I: IntoIterator<Item = S>, S: AsRef<OsStr>,

Executes a command as a child process, waiting for it to finish and collecting its exit status. Stdin, stdout and stderr are ignored.

Examples

use shell_util::{CommandOptions, Shell};
let status =
    Shell::status("echo", ["Hello!"], CommandOptions::default())
      .await
      .unwrap();
assert!(status.success);

pub fn spawn<I, S>( program: &str, args: I, options: &CommandOptions, ) -> Result<ChildProcess>

where I: IntoIterator<Item = S>, S: AsRef<OsStr>,

Spawns the command as a child process.

Examples

use shell_util::{CommandEvent, Shell};
let child = Shell::spawn("yes", [], CommandOptions::default())
  .expect("Failed to spawn yes.");

while let Some(event) = child.events().recv().await {
  if let CommandEvent::Stdout(buffer) = event {
    println!("stdout: {}", buffer.as_str().unwrap());
  }
}

Trait Implementations

impl Debug for Shell

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

Formats the value using the given formatter.