From 0f86553566eac6e006b2e9c0ed2d89701c2be8a6 Mon Sep 17 00:00:00 2001 From: Erik Kundt Date: Wed, 20 Mar 2024 09:49:14 +0100 Subject: [PATCH] lib: Add support for state value rollbacks --- src/flux/store.rs | 102 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 102 insertions(+) diff --git a/src/flux/store.rs b/src/flux/store.rs index 95ff9925..60ec1ebd 100644 --- a/src/flux/store.rs +++ b/src/flux/store.rs @@ -92,3 +92,105 @@ where Ok(result) } } + +/// A `StateValue` that writes updates to an internal +/// buffer. This buffer can be applied or reset. +/// +/// Reading from a `StateValue` will return the buffer if it's +/// not empty. It will return the actual value otherwise. +#[derive(Clone, Debug)] +pub struct StateValue +where + T: Clone, +{ + value: T, + buffer: Option, +} + +impl StateValue +where + T: Clone, +{ + pub fn new(value: T) -> Self { + Self { + value, + buffer: None, + } + } + + pub fn apply(&mut self) { + if let Some(buffer) = self.buffer.clone() { + self.value = buffer; + } + self.buffer = None; + } + + pub fn reset(&mut self) { + self.buffer = None; + } + + pub fn write(&mut self, value: T) { + self.buffer = Some(value); + } + + pub fn read(&self) -> T { + if let Some(buffer) = self.buffer.clone() { + buffer + } else { + self.value.clone() + } + } +} + +#[cfg(test)] +mod test { + use super::*; + + #[test] + fn state_value_read_should_succeed() { + let value = StateValue::new(0); + assert_eq!(value.read(), 0); + } + + #[test] + fn state_value_read_buffer_should_succeed() { + let mut value = StateValue::new(0); + value.write(1); + + assert_eq!(value.read(), 1); + } + + #[test] + fn state_value_apply_should_succeed() { + let mut value = StateValue::new(0); + + value.write(1); + assert_eq!(value.read(), 1); + + value.apply(); + assert_eq!(value.read(), 1); + } + + #[test] + fn state_value_reset_should_succeed() { + let mut value = StateValue::new(0); + + value.write(1); + assert_eq!(value.read(), 1); + + value.reset(); + assert_eq!(value.read(), 0); + } + + #[test] + fn state_value_reset_after_apply_should_succeed() { + let mut value = StateValue::new(0); + + value.write(1); + assert_eq!(value.read(), 1); + + value.apply(); + value.reset(); + assert_eq!(value.read(), 1); + } +}