Struct sprint::Shell

pub struct Shell {
    pub shell: Option<String>,
    pub dry_run: bool,
    pub sync: bool,
    pub print: bool,
    pub fence: String,
    pub info: String,
    pub prompt: String,
    pub fence_color: ColorSpec,
    pub info_color: ColorSpec,
    pub prompt_color: ColorSpec,
    pub command_color: ColorSpec,
    pub error_color: ColorSpec,
}

Command runner

Please see also the module-level documentation for a high-level description and examples.

use sprint::*;

// Use the default configuration:

let shell = Shell::default();

// Or a custom configuration:

let shell = Shell {
    shell: Some(String::from("sh -c")),
    //shell: Some(String::from("bash -c")), // Use bash
    //shell: Some(String::from("bash -xeo pipefail -c")), // Use bash w/ options
    //shell: None, // Run directly instead of a shell

    dry_run: false,
    sync: true,
    print: true,

    fence: String::from("```"),
    info: String::from("text"),
    prompt: String::from("$ "),

    fence_color: bunt::style!("#555555"),
    info_color: bunt::style!("#555555"),
    prompt_color: bunt::style!("#555555"),
    command_color: bunt::style!("#00ffff+bold"),
    error_color: bunt::style!("#ff0000+bold+italic"),
};

// Or modify it on the fly:

let mut shell = Shell::default();

shell.shell = None;
shell.sync = false;

// ...

Fields

shell: Option<String>

dry_run: bool

sync: bool

print: bool

fence: String

info: String

prompt: String

fence_color: ColorSpec

info_color: ColorSpec

prompt_color: ColorSpec

command_color: ColorSpec

error_color: ColorSpec

Implementations

impl Shell

pub fn run(&self, commands: &[Command]) -> Vec<Command>

Run command(s)

pub fn run1(&self, command: &Command) -> Command

Run a single command

pub fn pipe1(&self, command: &str) -> String

Pipe a single command

pub fn core(&self, command: &Command) -> Command

Core part to run/pipe a command

pub fn interactive_prompt(&self, previous: bool)

Print the interactive prompt

pub fn run_str(&self, commands: &[&str]) -> Vec<Command>

Simpler interface to run command(s)

Trait Implementations

impl Clone for Shell

fn clone(&self) -> Shell

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Shell

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

Formats the value using the given formatter.

impl Default for Shell

fn default() -> Shell

Default Shell