Enum xio_webapi::ControllerState

pub enum ControllerState {
    Uninitialized,
    FlashingFirmware,
    UnsupportedFrameFormatVersion {
        required: u8,
        found: Option<u8>,
    },
    UnsupportedCommandSetVersion {
        required: u16,
        found: Option<u16>,
    },
    Stale,
    Ready,
    JobSetDeployed {
        deployed_jobs: IndexSet<String>,
    },
    JobRunning {
        deployed_jobs: IndexSet<String>,
        running: String,
    },
}

The current state of a controller.

Variants

Uninitialized

The controller is uninitialized.

In this state, the controller can not be used. There is no information, why it has not been initialized. The reason may for example be that the initialization is ongoing, or that the controller has no firmware flashed.

FlashingFirmware

The controller firmware is currently being flashed.

UnsupportedFrameFormatVersion

The controller has an unsupported XIO frame format version.

Fields of UnsupportedFrameFormatVersion

required: u8

The frame format version required by the server.

found: Option<u8>

The frame format version found on the controller.

If the controller has answered to frame format version request, the result is stored here. Otherwise it is `None.

UnsupportedCommandSetVersion

The controller has an unsupported XIO commandset version.

Fields of UnsupportedCommandSetVersion

required: u16

The commandset version required by the server.

found: Option<u16>

The commandset version found on the controller.

If the controller has answered to frame format version request, the result is stored here. Otherwise it is `None.

Stale

The connection to the controller is stale.

Ready

The controller is ready for use, but has no jobset deployed.

JobSetDeployed

A jobset has been deployed, and no job is running.

Fields of JobSetDeployed

deployed_jobs: IndexSet<String>

The identifiers of the jobs that have been deployed.

JobRunning

A jobset has been deployed, and a job is currently running.

Fields of JobRunning

deployed_jobs: IndexSet<String>

The identifiers of the jobs that have been deployed.

running: String

The identifier of the job that is currently running.

It is one of the identifiers stored in the deployed_jobs field.

Trait Implementations

impl Eq for ControllerState

impl Default for ControllerState

fn default() -> Self

Returns the "default value" for a type.

impl Clone for ControllerState

fn clone(&self) -> ControllerState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<ControllerState> for ControllerState

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl ToString for ControllerState

fn to_string(&self) -> String

Converts the given value to a String.

impl Debug for ControllerState

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

Formats the value using the given formatter.

impl Serialize for ControllerState

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for ControllerState

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.