Enum brane_shr::jobs::JobStatus

#[repr(u8)]
pub enum JobStatus {
    Unknown,
    Created,
    CreateFailed {
        err: String,
    },
    Ready,
    Initialized,
    InitializeFailed {
        err: String,
    },
    Started,
    StartFailed {
        err: String,
    },
    Completed,
    CompleteFailed {
        err: String,
    },
    Finished {
        res: String,
    },
    Failed {
        res: String,
    },
    Stopped {
        signal: String,
    },
    DecodeFailed {
        err: String,
    },
}

Edited: added comments + synced with new events.

Lists the possible states that a job can have from the brane-drv perspective.

Variants

Unknown

Meta state for undefined states

Created

We successfully created a container for the call

CreateFailed

We could not create the container to run the call.

Carries

• err: A string describing why we failed to launch a job.

Fields

err: String

Ready

The container is ready with setting up the branelet executable (first opportunity for branelet to send events)

Initialized

The container has initialized its working directory

InitializeFailed

Something went wrong while setting up the working directory

Carries

• err: A string describing why we failed to intialize a job.

Fields

err: String

Started

The actual subcall executeable / script has started

StartFailed

The subprocess executable did not want to start (calling it failed)

Carries

• err: A string describing why we failed to start a job.

Fields

err: String

Completed

The subcall executable has finished without errors - at least, from the branelet’s side, that is

CompleteFailed

The subcall executable has finished with errors on the branelet side

Carries

• err: A string describing why we failed to complete a job.

Fields

err: String

Finished

The container has exited with a zero status code

Carries

• res: A JSON-formatted string (hopefully) containing the value of the finished job.

Fields

res: String

Failed

The container has exited with a non-zero status code

Carries

• res: A JSON-formatted string (hopefully) containing a code/stdout/stderr triplet of results of the failed job.

Fields

res: String

Stopped

The container was interrupted by the Job node

Fields

signal: String

DecodeFailed

We could not decode the output from the package

Carries

• err: A string describing why we failed to decode the job output.

Fields

err: String

Implementations

impl JobStatus

pub fn order(&self) -> u32

Converts any of the states to a numeric number representing their ordering.
The earlier the state in a job’s lifecycle, the lower the number.

Returns
The ordering as an unsigned integer.

pub fn reached(&self, target: &JobStatus) -> bool

Returns whether the this state is equal to or has surpassed the given state in terms of ordering.
In case they are equal, also requires the specific variants to be the same (not just the ordering).

Arguments

• target: The target state to check if the job has reached.

Returns
True if this state’s ordering is equal to or higher than the target’s ordering.

Trait Implementations

impl Clone for JobStatus

fn clone(&self) -> JobStatus

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JobStatus

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

Formats the value using the given formatter.

impl PartialEq<&JobStatus> for JobStatus

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

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

impl StructuralPartialEq for JobStatus