Struct sheller::Sheller

pub struct Sheller<'a> { /* private fields */ }

Sheller is a builder for std::process::Command that sets the shell program and arguments.

Please see the Sheller::new method for more information.

Implementations

impl<'a> Sheller<'a>

pub fn new(script: &'a str) -> Self

Create a new Sheller with the given script and platform-specific defaults.

Platform-specific defaults

Windows

When target_family is windows.

Set the COMSPEC environment variable to program, and if the environment variable is not set, use cmd.exe as the fallback program.

Also set the args to ["/D", "/S", "/C"].

Unix

When target_family is unix.

Set the SHELL environment variable to program, and if the environment variable is not set, use /bin/sh as the fallback program.

Also set the args to ["-c"].

Arguments

• script - The shell script to run. This is dependent on the shell program.

Examples

use sheller::Sheller;

let mut command = Sheller::new("echo hello").build();
assert!(command.status().unwrap().success());

pub fn build(self) -> Command

Returns std::process::Command with the shell program and arguments set.

Examples

use sheller::Sheller;

let mut command = Sheller::new("echo hello").build();
assert!(command.status().unwrap().success());

pub fn run(self)

Run the shell command and panic if the command failed to run.

Examples

use sheller::{Sheller, CommandExt};
let sheller = Sheller::new("echo hello");
sheller.run();

Panics

Panics if the command failed to run.

pub fn try_run(self) -> Result<(), Error>

Run the shell command and return a Result with Ok if the command was successful, and Err if the command failed.

Examples

use sheller::{Sheller, CommandExt};
let sheller = Sheller::new("echo hello");
sheller.try_run().unwrap();

Errors

Returns an Err if the command failed to run.

pub fn run_with_config(self, config: &Config)

Run the shell command with the given config and panic if the command failed to run.

Examples

use sheller::{Sheller, Config, CommandExt};
let sheller = Sheller::new("echo hello");
let config = Config::default();
sheller.run_with_config(&config);

Panics

Panics if the command failed to run.

pub fn try_run_with_config(self, config: &Config) -> Result<(), Error>

Run the shell command with the given config and return a Result with Ok if the command was successful, and Err if the command failed.

Examples

use sheller::{Sheller, Config, CommandExt};
let sheller = Sheller::new("echo hello");
let config = Config::default();
sheller.try_run_with_config(&config).unwrap();

Errors

Returns an Err if the command failed to run.

Trait Implementations

impl<'a> Debug for Sheller<'a>

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

Formats the value using the given formatter.

impl Default for Sheller<'_>

fn default() -> Self

Returns the “default value” for a type.