Enum Divert 

pub enum Divert {
    Continue {
        count: usize,
    },
    Break {
        count: usize,
    },
    Return(Option<ExitStatus>),
    Interrupt(Option<ExitStatus>),
    Exit(Option<ExitStatus>),
    Abort(Option<ExitStatus>),
}

Result of interrupted command execution.

Divert implements Ord. Values are ordered by severity.

Variants

Continue

Continue the current loop.

Fields

count: usize

Number of loops to break before continuing.

0 for continuing the innermost loop, 1 for one-level outer, and so on.

Break

Break the current loop.

Fields

count: usize

Number of loops to break.

0 for breaking the innermost loop, 1 for one-level outer, and so on.

Return(Option<ExitStatus>)

Return from the current function or script.

Interrupt(Option<ExitStatus>)

Interrupt the current shell execution environment.

This is the same as Exit in a non-interactive shell: it makes the shell exit after executing the EXIT trap, if any. If this is used inside the EXIT trap, the shell will exit immediately.

In an interactive shell, this will abort the currently executed command and resume prompting for a next command line.

Exit(Option<ExitStatus>)

Exit from the current shell execution environment.

This makes the shell exit after executing the EXIT trap, if any. If this is used inside the EXIT trap, the shell will exit immediately.

Abort(Option<ExitStatus>)

Exit from the current shell execution environment immediately.

This makes the shell exit without executing the EXIT trap.

Implementations

impl Divert

pub fn exit_status(&self) -> Option<ExitStatus>

Returns the exit status associated with the Divert.

Returns the variant’s value if self is Exit or Interrupt; otherwise, None.

Trait Implementations

impl Clone for Divert

fn clone(&self) -> Divert

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Divert

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

Formats the value using the given formatter.

impl Hash for Divert

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 Ord for Divert

fn cmp(&self, other: &Divert) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Divert

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

fn partial_cmp(&self, other: &Divert) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Divert

impl Eq for Divert

impl StructuralPartialEq for Divert