1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151

use super::TextName;
use serde::{Deserialize, Serialize};
use std::convert::TryInto;

/// A data structure containing information on a production job (i.e. a *job card*).
///
#[derive(Debug, Eq, PartialEq, Hash, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct JobCard<'a> {
    /// Unique job ID, which must not be empty or all white-spaces.
    #[serde(borrow)]
    job_card_id: TextName<'a>,
    //
    /// ID of the set of mold data to load for this job.
    #[serde(borrow)]
    mold_id: TextName<'a>,
    //
    /// Current production progress, which must not be larger than `total`.
    progress: u32,
    //
    /// Total production count ordered.
    total: u32,
}

impl<'a> JobCard<'a> {
    /// Get the job ID.
    ///
    /// # Examples
    ///
    /// ~~~
    /// # use ichen_openprotocol::*;
    /// # fn main() -> std::result::Result<(), String> {
    /// let jc = JobCard::try_new("J001", "Mold#001", 100, 1000)?;
    /// assert_eq!("J001", jc.job_card_id());
    /// # Ok(())
    /// # }
    /// ~~~
    pub fn job_card_id(&self) -> &str {
        self.job_card_id.as_ref()
    }

    /// Get the mold ID.
    ///
    /// # Examples
    ///
    /// ~~~
    /// # use ichen_openprotocol::*;
    /// # fn main() -> std::result::Result<(), String> {
    /// let jc = JobCard::try_new("J001", "Mold#001", 100, 1000)?;
    /// assert_eq!("Mold#001", jc.mold_id());
    /// # Ok(())
    /// # }
    /// ~~~
    pub fn mold_id(&self) -> &str {
        self.mold_id.as_ref()
    }

    /// Get the production progress.
    ///
    /// # Examples
    ///
    /// ~~~
    /// # use ichen_openprotocol::*;
    /// # fn main() -> std::result::Result<(), String> {
    /// let jc = JobCard::try_new("J001", "Mold#001", 100, 1000)?;
    /// assert_eq!(100, jc.progress());
    /// # Ok(())
    /// # }
    /// ~~~
    pub fn progress(&self) -> u32 {
        self.progress
    }

    /// Get the maximum production order.
    ///
    /// # Examples
    ///
    /// ~~~
    /// # use ichen_openprotocol::*;
    /// # fn main() -> std::result::Result<(), String> {
    /// let jc = JobCard::try_new("J001", "Mold#001", 100, 1000)?;
    /// assert_eq!(1000, jc.total());
    /// # Ok(())
    /// # }
    /// ~~~
    pub fn total(&self) -> u32 {
        self.total
    }

    /// Create a new `JobCard` with the specified field values.
    ///
    /// # Errors
    ///
    /// Returns `Err(String)` is there is an error in the parameters.
    ///
    /// ## Error Examples
    ///
    /// ~~~
    /// # use ichen_openprotocol::*;
    /// 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
    ///
    /// ~~~
    /// # use ichen_openprotocol::*;
    /// # fn main() -> std::result::Result<(), String> {
    /// 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());
    /// # Ok(())
    /// # }
    /// ~~~
    pub fn try_new(
        id: &'a str,
        mold: &'a str,
        progress: u32,
        total: u32,
    ) -> std::result::Result<Self, String> {
        if progress > total {
            return Err("progress cannot be larger than total".into());
        }

        Ok(Self {
            job_card_id: id.try_into().map_err(|e| format!("{} for job card ID", e))?,
            mold_id: mold.try_into().map_err(|e| format!("{} for mold ID", e))?,
            progress,
            total,
        })
    }
}