Enum Status 

pub enum Status {
    Success,
    Failure,
    Cancelled,
    Skipped,
    Pending,
}

The outcome of a CI job or step.

Examples

use helpers4::ci::Status;

assert_eq!(Status::from_conclusion("failure"), Some(Status::Failure));
assert_eq!(Status::Success.icon(), "\u{2705}");
assert_eq!(Status::Success.label(), "success");

Variants

Success

Finished without errors.

Failure

Finished with an error, or timed out.

Cancelled

Stopped before it finished.

Skipped

Not run.

Pending

Queued or still running.

Implementations

impl Status

pub fn from_conclusion(conclusion: &str) -> Option<Self>

Reads the conclusion names CI services use, ignoring case.

success, passed and pass are Status::Success; failure, failed, error and timed_out are Status::Failure; cancelled and canceled are Status::Cancelled; skipped is Status::Skipped; pending, queued, in_progress and running are Status::Pending.

Arguments

• conclusion - The name, such as "success" or "cancelled".

Returns

The status, or None for a name that is not one of those.

pub fn icon(self) -> &'static str

An emoji for the status, for a report or a PR comment.

Returns

\u{2705} for success, \u{274c} for failure, \u{1f6ab} for cancelled, \u{23ed}\u{fe0f} for skipped and \u{23f3} for pending.

pub fn label(self) -> &'static str

The lower-case name of the status.

Returns

"success", "failure", "cancelled", "skipped" or "pending".

Trait Implementations

impl Clone for Status

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Status

impl Debug for Status

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

Formats the value using the given formatter.

impl Eq for Status

impl FromStr for Status

type Err = ()

The associated error which can be returned from parsing.

fn from_str(conclusion: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Status

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 Status

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Status