Struct Result 

pub struct Result { /* private fields */ }

Result of built-in utility execution

The result type contains an exit status and optional flags that may affect the behavior of the shell following the built-in execution.

Implementations

impl Result

pub const fn new(exit_status: ExitStatus) -> Self

Creates a new result.

pub const fn with_exit_status_and_divert( exit_status: ExitStatus, divert: Result, ) -> Self

Creates a new result with a Divert.

pub const fn exit_status(&self) -> ExitStatus

Returns the exit status of this result.

The return value is the argument to the previous invocation of new or set_exit_status.

pub fn set_exit_status(&mut self, exit_status: ExitStatus)

Sets the exit status of this result.

See exit_status.

pub const fn divert(&self) -> Result

Returns an optional Divert to be taken.

The return value is the argument to the previous invocation of set_divert. The default is Continue(()).

pub fn set_divert(&mut self, divert: Result)

Sets a Divert.

See divert.

pub const fn should_retain_redirs(&self) -> bool

Tests whether the caller should retain redirections.

Usually, the shell reverts redirections applied to a built-in after executing it. However, redirections applied to a successful exec built-in should persist. To make it happen, the exec built-in calls retain_redirs, and this function returns true. In that case, the caller of the built-in should take appropriate actions to preserve the effect of the redirections.

pub fn retain_redirs(&mut self)

Flags that redirections applied to the built-in should persist.

Calling this function makes should_retain_redirs return true. clear_redirs cancels the effect of this function.

pub fn clear_redirs(&mut self)

Cancels the effect of retain_redirs.

pub fn max(self, other: Self) -> Self

Merges two results by taking the maximum of each field.

Trait Implementations

impl Clone for Result

fn clone(&self) -> Result

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Result

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

Formats the value using the given formatter.

impl Default for Result

fn default() -> Self

Returns the “default value” for a type.

impl From<ExitStatus> for Result

fn from(exit_status: ExitStatus) -> Self

Converts to this type from the input type.

impl Hash for Result

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 Result

fn eq(&self, other: &Result) -> 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 Copy for Result

impl Eq for Result

impl StructuralPartialEq for Result