Struct ExitStatus 

pub struct ExitStatus(/* private fields */);

How the sandboxed command terminated.

Returned by Cage::run whenever the command was executed, regardless of its exit code: a non-zero exit is data, not an error. The status reflects either a normal exit with a code or termination by a signal, exactly one of which applies.

Implementations

impl ExitStatus

pub fn success(&self) -> bool

Returns true if the command exited normally with code 0.

pub fn code(&self) -> Option<i32>

The exit code, if the command exited normally.

pub fn signal(&self) -> Option<i32>

The signal number that terminated the command, if it was terminated by a signal.

pub fn shell_code(&self) -> u8

The status as a process exit code, following the shell’s convention.

A command that exited reports its own code; a command a signal terminated reports 128 + signal, which is what sh reports in $? and what a caller propagating the outcome to its own exit status wants. This is what the fcage binary returns, and what a consumer that re-exports a sandboxed command’s outcome should return.

The result is a u8 because that is the width a process exit status has: wait carries eight bits, so a code outside 0..=255 was never reachable and no case is lost by narrowing here.

Example

use std::process::ExitCode;

use ferroday_cage::Cage;

let status = Cage::builder().command("/bin/false").rootfs(rootfs).build()?.run()?;
let _code = ExitCode::from(status.shell_code());

Trait Implementations

impl Clone for ExitStatus

fn clone(&self) -> ExitStatus

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ExitStatus

impl Debug for ExitStatus

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

Formats the value using the given formatter.

impl Display for ExitStatus

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

Formats the value using the given formatter.

impl Eq for ExitStatus

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 for ExitStatus

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ExitStatus