lib: Add support for state value rollbacks

This commit is contained in:
Erik Kundt
2024-03-20 09:49:14 +01:00
parent 1fd061770d
commit 0f86553566
+102
View File
@@ -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<T>
where
T: Clone,
{
value: T,
buffer: Option<T>,
}
impl<T> StateValue<T>
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);
}
}