Refactoring - small, miscellaneous code quality improvements

Author: ndebuhr

sim/src/models/batcher.rs

@@ -78,7 +78,7 @@ impl Batcher {
             ports_out: PortsOut { job: job_out_port },
             max_batch_time,
             max_batch_size,
-            state: Default::default(),
+            state: State::default(),
         }
     }
 

sim/src/models/exclusive_gateway.rs

@@ -98,7 +98,7 @@ impl ExclusiveGateway {
             },
             port_weights,
             store_records,
-            state: Default::default(),
+            state: State::default(),
         }
     }
 

sim/src/models/gate.rs

@@ -110,7 +110,7 @@ impl Gate {
                 records: default_records_port_name(),
             },
             store_records,
-            state: Default::default(),
+            state: State::default(),
         }
     }
 
@@ -238,8 +238,7 @@ impl AsModel for Gate {
             Phase::Open => String::from("Open"),
             Phase::Closed => String::from("Closed"),
             Phase::Pass => format!["Passing {}", self.state.jobs[0].content],
-            Phase::RespondWhileOpen => String::from("Fetching records"),
-            Phase::RespondWhileClosed => String::from("Fetching records"),
+            Phase::RespondWhileOpen | Phase::RespondWhileClosed => String::from("Fetching records"),
         }
     }
 
@@ -269,9 +268,7 @@ impl AsModel for Gate {
         _services: &mut Services,
     ) -> Result<Vec<ModelMessage>, SimulationError> {
         match &self.state.phase {
-            Phase::Open => self.send_jobs(),
-            Phase::Closed => self.send_jobs(),
-            Phase::Pass => self.send_jobs(),
+            Phase::Open | Phase::Closed | Phase::Pass => self.send_jobs(),
             Phase::RespondWhileOpen => self.send_records_while_open(),
             Phase::RespondWhileClosed => self.send_records_while_closed(),
         }

sim/src/models/generator.rs

@@ -107,7 +107,7 @@ impl Generator {
                 records: default_records_port_name(),
             },
             store_records,
-            state: Default::default(),
+            state: State::default(),
         }
     }
 
@@ -207,8 +207,7 @@ impl AsModel for Generator {
     ) -> Result<Vec<ModelMessage>, SimulationError> {
         match (&self.state.phase, self.store_records) {
             (Phase::Generating, true) => self.save_job(services),
-            (Phase::Generating, false) => self.release_job(services),
-            (Phase::Saved, _) => self.release_job(services),
+            (Phase::Generating, false) | (Phase::Saved, _) => self.release_job(services),
             (Phase::RecordsFetch, true) => self.release_records(),
             (Phase::RecordsFetch, false) => Err(SimulationError::InvalidModelState),
             (Phase::Initializing, _) => self.initialize_generation(services),

sim/src/models/load_balancer.rs

@@ -93,7 +93,7 @@ impl LoadBalancer {
                 records: default_records_port_name(),
             },
             store_records,
-            state: Default::default(),
+            state: State::default(),
         }
     }
 

sim/src/models/parallel_gateway.rs

@@ -98,7 +98,7 @@ impl ParallelGateway {
                 records: default_records_port_name(),
             },
             store_records,
-            state: Default::default(),
+            state: State::default(),
         }
     }
 

sim/src/models/processor.rs

@@ -119,7 +119,7 @@ impl Processor {
                 records: default_records_port_name(),
             },
             store_records,
-            state: Default::default(),
+            state: State::default(),
         }
     }
 

sim/src/models/stochastic_gate.rs

@@ -100,7 +100,7 @@ impl StochasticGate {
                 records: default_records_port_name(),
             },
             store_records,
-            state: Default::default(),
+            state: State::default(),
         }
     }
 

sim/src/models/stopwatch.rs

@@ -133,7 +133,7 @@ impl Stopwatch {
             },
             metric,
             store_records,
-            state: Default::default(),
+            state: State::default(),
         }
     }
 
@@ -304,8 +304,10 @@ impl AsModel for Stopwatch {
                 .state
                 .jobs
                 .iter()
-                .filter_map(|job| self.some_duration(job))
-                .map(|(_, duration)| duration)
+                .filter_map(|job| {
+                    self.some_duration(job)
+                        .map(|duration_record| duration_record.1)
+                })
                 .collect();
             format![
                 "Average {:.3}",
@@ -323,10 +325,12 @@ impl AsModel for Stopwatch {
             self.arrival_port(&incoming_message.port_name),
             self.store_records,
         ) {
-            (ArrivalPort::Start, true) => self.calculate_and_save_job(incoming_message, services),
-            (ArrivalPort::Stop, true) => self.calculate_and_save_job(incoming_message, services),
-            (ArrivalPort::Start, false) => self.calculate_job(incoming_message, services),
-            (ArrivalPort::Stop, false) => self.calculate_job(incoming_message, services),
+            (ArrivalPort::Start, true) | (ArrivalPort::Stop, true) => {
+                self.calculate_and_save_job(incoming_message, services)
+            }
+            (ArrivalPort::Start, false) | (ArrivalPort::Stop, false) => {
+                self.calculate_job(incoming_message, services)
+            }
             (ArrivalPort::Metric, _) => self.get_job(),
             (ArrivalPort::Records, _) => self.get_records(),
             (ArrivalPort::Unknown, _) => Err(SimulationError::InvalidMessage),

sim/src/models/storage.rs

@@ -105,7 +105,7 @@ impl Storage {
                 records: default_records_port_name(),
             },
             store_records,
-            state: Default::default(),
+            state: State::default(),
         }
     }
 

sim/src/output_analysis/mod.rs

@@ -41,8 +41,8 @@ where
         / usize_to_float(points.len())?)
 }
 
-/// This function converts a usize to a Float, with an associated SimulationError
-/// returned for failed conversions
+/// This function converts a usize to a Float, with an associated
+/// `SimulationError` returned for failed conversions
 fn usize_to_float<T: Float>(unconv: usize) -> Result<T, SimulationError> {
     T::from(unconv).ok_or(SimulationError::FloatConvError)
 }
@@ -242,9 +242,8 @@ where
                 // Use that point for deletion determination
                 self.deletion_point = mser.iter().position(|mser_value| *mser_value == min_mser);
                 break;
-            } else {
-                d -= 1;
             }
+            d -= 1;
         }
         // Schmeiser [1982] found that, for a fixed total sample size, there
         // is little benefit from dividing it into more than k = 30 batches,

sim/src/simulator/mod.rs

@@ -234,7 +234,7 @@ impl Simulation {
             .collect();
         errors?;
         self.messages = next_messages;
-        Ok(self.get_messages().to_vec())
+        Ok(self.get_messages().clone())
     }
 
     /// This method executes simulation `step` calls, until a global time
@@ -264,7 +264,7 @@ impl Simulation {
                 message_records.extend(self.messages.clone());
                 Ok(Vec::new())
             })
-            .find(|result| result.is_err())
+            .find(Result::is_err)
             .unwrap_or(Ok(message_records))
     }
 }

sim/src/utils/errors.rs

@@ -1,6 +1,6 @@
 use thiserror::Error;
 
-/// SimulationError enumerates all possible errors returned by sim
+/// `SimulationError` enumerates all possible errors returned by sim
 #[derive(Error, Debug)]
 pub enum SimulationError {
     /// Represents an invalid model configuration encountered during simulation