Struct Command

pub struct Command { /* private fields */ }

Run a CLI command and store its stdout.

Example

#[cfg(target_os = "macos")]
let command = Command::new("uname", r#"/usr/bin/uname -a"#)
    .with_title("Host OS")
    .with_timeout(5);
#[cfg(target_os = "linux")]
let command = Command::new("true", r#"/bin/true"#)
    .with_title("Just a successful command")
    .with_timeout(5);
match command.exec() {
    CommandResult::Success {
        command: _,
        run_time_ms: _,
        stdout: stdout,
    } => println!("Command output '{}'", stdout),
    CommandResult::Failed {
        command: _,
        run_time_ms: _,
        stdout: stdout,
    } => println!("Command failed with output '{}'", stdout),
    CommandResult::Timeout {
        command: _,
        run_time_ms: _,
    } => println!("Command timed out"),
    CommandResult::Error {
        command: _,
        reason: reason,
    } => println!("Command errored because {}", reason),
};

Implementations

impl Command

pub fn new<T: Into<String>>(name: T, command: T) -> Command

Create new command with default values

pub fn name(&self) -> &str

Get name of command

pub fn command(&self) -> &str

Get command args

pub fn title(&self) -> Option<&str>

Get title of command

pub fn description(&self) -> Option<&str>

Get description of command

pub fn with_title<T: Into<String>>(self, title: T) -> Command

Set title of command

pub fn with_timeout<T: Into<Option<u64>>>(self, timeout_sec: T) -> Command

Set title of command

pub fn with_description<T: Into<String>, S: Into<Option<T>>>( self, description: S, ) -> Command

Set description of command

pub fn with_links<T: Into<Option<Vec<Link>>>>(self, links: T) -> Command

Set Links of command

pub fn exec(self) -> CommandResult

Execute this command; may panic

Standard output and error will be written to a temporary file, because a pipe may only contain up 64 KB data; cf. http://man7.org/linux/man-pages/man7/pipe.7.html.

Trait Implementations

impl Clone for Command

fn clone(&self) -> Command

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Command

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Command

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Command

fn eq(&self, other: &Command) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Command

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Command

impl StructuralPartialEq for Command