Struct TrackedState 

pub struct TrackedState<T>(/* private fields */);

Struct for storing state variable and ensuring one mutation per initialization or reset – i.e. one mutation per time step

Implementations

impl<T> TrackedState<T>

where T: Debug + Clone + PartialEq + Default,

Provides methods to guarantee that states are updated once and only once per time step

pub fn new(value: T) -> Self

pub fn inner(&self) -> &T

Returns a reference to the inner value without freshness checking. Intended for use with #[serde(serialize_with)] helpers.

pub fn mark_stale(&mut self)

Reset the tracked state to [State::Stale] for the next update after verifying that is has been updated

pub fn update<F: Fn() -> String>(&mut self, value: T, loc: F) -> Result<()>

Update the value of the tracked state after verifying that it has not already been updated

Arguments

• value: new value
• loc: closure that returns file and line number where called

pub fn update_unchecked<F: Fn() -> String>( &mut self, value: T, _loc: F, ) -> Result<()>

Update the value of the tracked state without verifying that it has not already been updated – to be used sparingly!

Arguments

• value: new value
• loc: closure that returns file and line number where called

pub fn get_fresh<F: Fn() -> String>(&self, loc: F) -> Result<&T>

Check that value has been updated and then return as a result

Arguments

• loc: call site location filename and line number

pub fn get_stale<F: Fn() -> String>(&self, loc: F) -> Result<&T>

Check that value has not been updated and then return as a result

Arguments

• loc: call site location filename and line number

impl<T: Debug + Clone + PartialEq + Default + AddAssign> TrackedState<T>

State methods that allow for +=

pub fn increment<F: Fn() -> String>(&mut self, value: T, loc: F) -> Result<()>

Update the value of the tracked state

Arguments

• value: new value
• loc: closure that returns file and line number where called

Trait Implementations

impl<T: Clone> Clone for TrackedState<T>

fn clone(&self) -> TrackedState<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Copy> Copy for TrackedState<T>

impl<T: Debug> Debug for TrackedState<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for TrackedState<T>

fn default() -> TrackedState<T>

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for TrackedState<T>

where T: Debug + Clone + PartialEq + Deserialize<'de> + Serialize + Default,

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: Display> Display for TrackedState<T>

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

Formats the value using the given formatter.

impl<T: PartialEq> PartialEq for TrackedState<T>

fn eq(&self, other: &TrackedState<T>) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<T> Serialize for TrackedState<T>

where T: Debug + Clone + PartialEq + for<'de> Deserialize<'de> + Serialize + Default,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: PartialEq> StructuralPartialEq for TrackedState<T>

impl<T> TrackedStateMethods for TrackedState<T>

where T: Debug + Clone + PartialEq + Default,

fn mark_fresh<F: Fn() -> String>(&mut self, loc: F) -> Result<()>

Verify that state is [State::Stale] and mark state as [State::Fresh] without updating

Arguments

• loc: closure that returns file and line number where called

fn check_and_reset<F: Fn() -> String>(&mut self, loc: F) -> Result<()>

Ensure [State::Fresh] and reset to [State::Stale]