Enum Status

pub enum Status {
    Previous,
    Unset,
    Named(String),
}

The return status of an invoked command.

Variants

Previous

No new status was set, and nothing was sent, so instead we are to assume the previous status is still in effect.

Unset

Something was sent, but we couldn’t identify it as status.

Named(String)

Assume the given named status.

Implementations

impl Status

Initialization

pub fn success() -> Self

Create a new instance that represents a successful operation.

pub fn delayed() -> Self

Create a new instance that represents a delayed operation.

pub fn abort() -> Self

Create a status that indicates to the client that the command that caused it will not be run anymore throughout the lifetime of the process. However, other commands may still run.

pub fn exit() -> Self

Create a status that makes the client send a kill signal.

pub fn error(message: impl Into<String>) -> Self

Create a new instance that represents an error with the given message.

impl Status

Access

pub fn is_success(&self) -> bool

Note that this is assumed true even if no new status is set, hence we assume that upon error, the caller will not continue interacting with the process.

pub fn is_abort(&self) -> bool

Returns true if this is an abort status.

pub fn is_delayed(&self) -> bool

Return true if the status is explicitly set to indicated delayed output processing

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

Return the status message if present.

Trait Implementations

impl Clone for Status

fn clone(&self) -> Status

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Status

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

Formats the value using the given formatter.