Struct TransientState

pub struct TransientState<T> { /* private fields */ }

Implementations

impl<T> TransientState<T>

pub fn new() -> Self

pub fn get(&self) -> StateRef<'_, Option<T>>

Gets the current value of the state. The current task will be registered as dependency of the state and will be invalidated when the state changes.

pub fn get_untracked(&self) -> StateRef<'_, Option<T>>

Gets the current value of the state. Untracked.

pub fn set_unconditionally(&self, value: T)

Sets the current state without comparing it with the old value. This should only be used if one is sure that the value has changed.

pub fn unset_unconditionally(&self)

Unset the current value without comparing it with the old value. This should only be used if one is sure that the value has changed.

pub fn update_conditionally(&self, update: impl FnOnce(&mut Option<T>) -> bool)

Updates the current state with the update function. The update function need to return true when the value was modified. Exposing the current value from the update function is not allowed and will result in incorrect cache invalidation.

impl<T: PartialEq> TransientState<T>

pub fn set(&self, value: T)

Update the current state when the value is different from the current value. T must implement PartialEq for this to work.

pub fn unset(&self)

Unset the current value.

Trait Implementations

impl<T: Debug> Debug for TransientState<T>

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

Formats the value using the given formatter.

impl<T> Default for TransientState<T>

fn default() -> Self

Returns the “default value” for a type.

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

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> PartialEq for TransientState<T>

fn eq(&self, _other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> Serialize for TransientState<T>

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: TraceRawVcs> TraceRawVcs for TransientState<T>

fn trace_raw_vcs(&self, trace_context: &mut TraceRawVcsContext)

fn get_raw_vcs(&self) -> Vec<RawVc>

impl<T> Eq for TransientState<T>

impl<T: NonLocalValue> NonLocalValue for TransientState<T>

impl<T: OperationValue> OperationValue for TransientState<T>