Struct ichen_openprotocol::JobCard

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

A data structure containing information on a production job (i.e. a job card).

Methods

impl<'a> JobCard<'a>

pub fn job_card_id(&self) -> &str

Get the job ID.

Examples

let jc = JobCard::try_new("J001", "Mold#001", 100, 1000)?;
assert_eq!("J001", jc.job_card_id());

pub fn mold_id(&self) -> &str

Get the mold ID.

Examples

let jc = JobCard::try_new("J001", "Mold#001", 100, 1000)?;
assert_eq!("Mold#001", jc.mold_id());

pub fn progress(&self) -> u32

Get the production progress.

Examples

let jc = JobCard::try_new("J001", "Mold#001", 100, 1000)?;
assert_eq!(100, jc.progress());

pub fn total(&self) -> u32

Get the maximum production order.

Examples

let jc = JobCard::try_new("J001", "Mold#001", 100, 1000)?;
assert_eq!(1000, jc.total());

pub fn try_new(
    id: &'a str,
    mold: &'a str,
    progress: u32,
    total: u32
) -> Result<Self, String>

Create a new JobCard with the specified field values.

Errors

Returns Err(String) is there is an error in the parameters.

Error Examples

assert_eq!(
    Err("invalid value: a non-empty, non-whitespace string required for job card ID".into()),
    JobCard::try_new("", "Mold#001", 0, 10000)
);

assert_eq!(
    Err("invalid value: a non-empty, non-whitespace string required for mold ID".into()),
    JobCard::try_new("J001", "   ", 0, 10000)
);

assert_eq!(
    Err("progress cannot be larger than total".into()),
    JobCard::try_new("J001", "Mold#001", 1000, 100)
);

Examples

let jobs = vec![
    JobCard::try_new("J001", "Mold#001", 0, 10000)?,
    JobCard::try_new("J002", "Mold#002", 1000, 5000)?,
    JobCard::try_new("J003", "Mold#003", 42, 1000)?,
    JobCard::try_new("J004", "Mold#004", 0, 0)?,
];

assert_eq!(4, jobs.len());
assert_eq!("J002", jobs[1].job_card_id());
assert_eq!(1000, jobs[2].total());

Trait Implementations

impl<'a> Clone for JobCard<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for JobCard<'a>

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

Formats the value using the given formatter.

impl<'de: 'a, 'a> Deserialize<'de> for JobCard<'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 JobCard<'a>

impl<'a> Hash for JobCard<'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<JobCard<'a>> for JobCard<'a>

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

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

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

This method tests for !=.

impl<'a> Serialize for JobCard<'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 JobCard<'a>

impl<'a> StructuralPartialEq for JobCard<'a>