Enum brane_tsk::spec::JobStatus

pub enum JobStatus {
    Unknown,
    Received,
    Authorized,
    Denied,
    AuthorizationFailed(String),
    Created,
    CreationFailed(String),
    Ready,
    Initialized,
    InitializationFailed(String),
    Started,
    StartingFailed(String),
    Heartbeat,
    Completed,
    CompletionFailed(String),
    Finished(FullValue),
    Stopped,
    DecodingFailed(String),
    Failed(i32, String, String),
}

Defines the possible states a job can have.

Variants

Unknown

No status yet / unknown

Received

The job has been received by the job node.

Authorized

The job has been authorized by the job’s checker(s).

Denied

The job has been denied by the job’s checker(s).

AuthorizationFailed(String)

Authorization has failed.

Created

The job container has been created.

CreationFailed(String)

We failed to create the job container.

Ready

The branelet has been booted (first event it sends).

Initialized

The branelet node has been initialized; now only to spawn the job itself.

InitializationFailed(String)

We failed to initialize branelet.

Started

The actual subcall executeable / script has started

StartingFailed(String)

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

Heartbeat

Occassional message to let the user know the container is alive and running

Completed

The package call went successfully from the branelet’s side

CompletionFailed(String)

The package call went wrong from the branelet’s side

Finished(FullValue)

The container has exited with a zero status code (and returned the given value, which may be Void)

Stopped

The container was interrupted by the Job node

DecodingFailed(String)

brane-let could not decode the output from the package call

Failed(i32, String, String)

The container has exited with a non-zero status code

Implementations

impl JobStatus

pub fn from_status( status: TaskStatus, value: Option<String>, ) -> Result<Self, ExecuteError>

Attempts to parse the given status & value into a JobStatus.

Arguments

• status: The ExecuteState that provides the wire status.
• value: The optional String value that we will parse to values or errors.

Returns

A new JobStatus instance.

Errors

This function errors if we failed to parse the string, or it was None when we expected Some.

pub fn is_heartbeat(&self) -> bool

Returns whether this status is a heartbeat.

pub fn progress_index(&self) -> u32

Converts the JobStatus into some ‘progress index’, which is a number that can be used to determine if some JobStatus logically should be send after another.

Returns

A number representing the progress index. If it’s higher than that of another JobStatus, this indicates its part of a later ‘step’ in the process.

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 From<&JobStatus> for (TaskStatus, Option<String>)

fn from(value: &JobStatus) -> Self

Converts to this type from the input type.

impl From<&JobStatus> for TaskStatus

fn from(value: &JobStatus) -> Self

Converts to this type from the input type.

impl From<JobStatus> for (TaskStatus, Option<String>)

fn from(value: JobStatus) -> Self

Converts to this type from the input type.

impl From<JobStatus> for TaskStatus

fn from(value: JobStatus) -> Self

Converts to this type from the input type.

impl PartialEq for JobStatus

fn eq(&self, other: &Self) -> 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.