Struct term_transcript::ExitStatus

pub struct ExitStatus(pub i32);

Portable, platform-independent version of ExitStatus from the standard library.

Capturing ExitStatus

Some shells have means to check whether the input command was executed successfully. For example, in sh-like shells, one can compare the value of $? to 0, and in PowerShell to True. The exit status can be captured when creating a Transcript by setting a checker in ShellOptions::with_status_check():

Examples

let options = ShellOptions::default();
let mut options = options.with_status_check("echo $?", |captured| {
    // Parse captured string to plain text. This transform
    // is especially important in transcripts captured from PTY
    // since they can contain a *wild* amount of escape sequences.
    let captured = captured.to_plaintext().ok()?;
    let code: i32 = captured.trim().parse().ok()?;
    Some(ExitStatus(code))
});

let transcript = Transcript::from_inputs(&mut options, [
    UserInput::command("echo \"Hello world\""),
    UserInput::command("some-non-existing-command"),
])?;
let status = transcript.interactions()[0].exit_status();
assert!(status.unwrap().is_success());
// The assertion above is equivalent to:
assert_eq!(status, Some(ExitStatus(0)));

let status = transcript.interactions()[1].exit_status();
assert!(!status.unwrap().is_success());

Tuple Fields

0: i32

Implementations

impl ExitStatus

pub fn is_success(self) -> bool

Checks if this is the successful status.

Trait Implementations

impl Clone for ExitStatus

fn clone(&self) -> ExitStatus

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExitStatus

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

Formats the value using the given formatter.

impl Hash for ExitStatus

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<ExitStatus> for ExitStatus

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for ExitStatus

impl Eq for ExitStatus

impl StructuralEq for ExitStatus

impl StructuralPartialEq for ExitStatus