Struct ichen_openprotocol::StateValues

pub struct StateValues<'a> { /* fields omitted */ }

A data structure containing a snapshot of the current known states of the controller.

Methods

impl<'a> StateValues<'a>

pub fn op_mode(&self) -> OpMode

Get the op-mode.

Examples

let state = StateValues::try_new_with_all(
    OpMode::Automatic,
    JobMode::ID02,
    Some(ID::from_u32(123)),
    None,
    Some("M001")
)?;

assert_eq!(OpMode::Automatic, state.op_mode());

pub fn job_mode(&self) -> JobMode

Get the job mode.

Examples

let state = StateValues::try_new_with_all(
    OpMode::Automatic,
    JobMode::ID02,
    Some(ID::from_u32(123)),
    None,
    Some("M001")
)?;

assert_eq!(JobMode::ID02, state.job_mode());

pub fn operator_id(&self) -> Option<ID>

Get the operator ID, if any.

Examples

let state = StateValues::try_new_with_all(
    OpMode::Automatic,
    JobMode::ID02,
    Some(ID::from_u32(123)),
    None,
    Some("M001")
)?;

assert_eq!(123, state.operator_id().unwrap());

pub fn job_card_id(&self) -> Option<&str>

Get the job card ID, if any.

Examples

let state = StateValues::try_new_with_all(
    OpMode::Automatic,
    JobMode::ID02,
    Some(ID::from_u32(123)),
    Some("JC001"),
    None
)?;

assert_eq!(Some("JC001"), state.job_card_id());

pub fn mold_id(&self) -> Option<&str>

Get the mold ID, if any.

Examples

let state = StateValues::try_new_with_all(
    OpMode::Automatic,
    JobMode::ID02,
    Some(ID::from_u32(123)),
    None,
    Some("M001")
)?;

assert_eq!(Some("M001"), state.mold_id());

pub fn new(op: OpMode, job: JobMode) -> Self

Create a new StateValues wth no operator ID, job card ID and mold ID.

Examples

let state = StateValues::new(OpMode::Automatic, JobMode::ID02);
assert_eq!(OpMode::Automatic, state.op_mode());
assert_eq!(JobMode::ID02, state.job_mode());
assert_eq!(None, state.operator_id());
assert_eq!(None, state.job_card_id());
assert_eq!(None, state.mold_id());

pub fn try_new_with_all(
    op: OpMode,
    job: JobMode,
    operator_id: Option<ID>,
    job_card_id: Option<&'a str>,
    mold_id: Option<&'a str>
) -> Result<Self, String>

Create a new StateValues with all fields set.

Errors

Returns Err(String) if job_card_id or mold_id is set to an empty string or is all whitespace.

Error Examples

let sv = StateValues::try_new_with_all(
    OpMode::Automatic,
    JobMode::ID02,
    Some(ID::from_u32(123)),
    Some(""),    // <-- Notice empty string for job_Card_id which is not allowed
    None
);
assert_eq!(Err("invalid value: a non-empty, non-whitespace string required for job card ID".into()), sv);

Examples

let state = StateValues::try_new_with_all(
    OpMode::Automatic,
    JobMode::ID02,
    Some(ID::from_u32(123)),
    None,
    Some("M001")
)?;

assert_eq!(OpMode::Automatic, state.op_mode());
assert_eq!(JobMode::ID02, state.job_mode());
assert_eq!(123, state.operator_id().unwrap());
assert_eq!(None, state.job_card_id());
assert_eq!(Some("M001"), state.mold_id());

Trait Implementations

impl<'a> Clone for StateValues<'a>

fn clone(&self) -> StateValues<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for StateValues<'a>

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

Formats the value using the given formatter.

impl<'_> Default for StateValues<'_>

fn default() -> Self

Default value of StateValues.

impl<'de: 'a, 'a> Deserialize<'de> for StateValues<'a>

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

Deserialize this value from the given Serde deserializer.

impl<'a> Eq for StateValues<'a>

impl<'a> Hash for StateValues<'a>

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<'a> PartialEq<StateValues<'a>> for StateValues<'a>

fn eq(&self, other: &StateValues<'a>) -> bool

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

fn ne(&self, other: &StateValues<'a>) -> bool

This method tests for !=.

impl<'a> Serialize for StateValues<'a>

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

Serialize this value into the given Serde serializer.

impl<'a> StructuralEq for StateValues<'a>

impl<'a> StructuralPartialEq for StateValues<'a>