Enum ichen_openprotocol::JobMode

pub enum JobMode {
    Unknown,
    ID01,
    ID02,
    ID03,
    ID04,
    ID05,
    ID06,
    ID07,
    ID08,
    ID09,
    ID10,
    ID11,
    ID12,
    ID13,
    ID14,
    ID15,
    Offline,
}

Job modes of the controller.

On some controller models, job modes 1-15 (ID01 - ID15) can be user-defined.

See this document for details.

Variants

Unknown

Unknown job mode.

ID01

ID02

ID03

ID04

ID05

ID06

ID07

ID08

ID09

ID10

ID11

ID12

ID13

ID14

ID15

Offline

The controller is off-line.

When the controller is off-line, both its operating mode and job mode should be Offline.

Methods

impl JobMode

pub fn is_unknown(&self) -> bool

Returns true if Unknown.

Examples

assert!(JobMode::Unknown.is_unknown());
assert!(!JobMode::ID08.is_unknown());

pub fn is_offline(&self) -> bool

Returns true if Offline.

Examples

assert!(JobMode::Offline.is_offline());
assert!(!JobMode::ID08.is_offline());

pub fn is_online(&self) -> bool

Returns true for all variants other than Unknown and Offline.

Examples

assert!(!JobMode::Offline.is_online());
assert!(!JobMode::Unknown.is_online());
assert!(JobMode::ID01.is_online());
assert!(JobMode::ID15.is_online());

Trait Implementations

impl Clone for JobMode

fn clone(&self) -> JobMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for JobMode

impl Debug for JobMode

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

Formats the value using the given formatter.

impl Default for JobMode

fn default() -> Self

Default value for JobMode.

impl<'de> Deserialize<'de> for JobMode

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

Deserialize this value from the given Serde deserializer.

impl Display for JobMode

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

Formats the value using the given formatter.

impl Eq for JobMode

impl Hash for JobMode

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, 

Feeds a slice of this type into the given [Hasher].

impl Ord for JobMode

fn cmp(&self, other: &JobMode) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use] fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use] fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use] fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<JobMode> for JobMode

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<JobMode> for JobMode

fn partial_cmp(&self, other: &JobMode) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use] fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use] fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use] fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use] fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for JobMode

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

Serialize this value into the given Serde serializer.

impl StructuralEq for JobMode

impl StructuralPartialEq for JobMode