Struct Control 

pub struct Control<T: ?Sized> { /* private fields */ }

Marks a variable as a state variable which can be used in conjunction with the until!-macro.

Whenever a control variable changes its value, the runtime system checks whether any other parts of the model are currently waiting for the variable to attain a certain value.

Implementations

impl<T> Control<T>

pub fn new(value: T) -> Self

Creates a new control variable and initializes its value.

pub fn set(&self, val: T)

Assigns a new value to the control variable.

This can lead to potential activations of waiting processes.

pub fn get(&self) -> T

where T: Copy,

Returns a copy of the stored inner value.

pub fn swap(&self, other: &Self)

Swaps the values of two control variables. The difference to core::mem::swap is that this function doesn’t require an exclusive reference.

pub fn replace(&self, val: T) -> T

Replaces the current value of the control variable with a new one and returns it.

This can lead to potential activations of waiting processes.

pub fn update<F>(&self, f: F)

where F: FnOnce(T) -> T, T: Copy,

Updates the contained value using a function and returns the new value.

pub fn take(&self) -> T

where T: Default,

Takes the value of the control variable, leaving Default::default() in its place.

pub fn get_mut(&mut self) -> &mut T

Returns a mutable reference to the underlying data.

This call borrows the control variable mutably (at compile-time) which guarantees that we possess the only reference.

pub fn unchecked_set(&self, val: T)

Assigns a new value to the control variable without notifying pending control conditions.

Use this method if you want to change the inner value without scheduling continuations that depend on it. Once finished, you may call notify directly.

Trait Implementations

impl<T: Debug> Debug for Control<T>

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

Formats the value using the given formatter.

impl<T: Default + ?Sized> Default for Control<T>

fn default() -> Control<T>

Returns the “default value” for a type.

impl<T: Display> Display for Control<T>

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

Formats the value using the given formatter.

impl<T: Copy> Expr for Control<T>

type Output = T

The result type.

fn get(&self) -> T

The routine used for evaluation.

impl<T: ?Sized> Publisher for Control<T>

type Link = Link<UnsafeRef<Predicate>>

The type of the object this notifier informs.

unsafe fn subscribe(&self, link: Pin<&Self::Link>)

Unsafely subscribes a link to the notifier.

unsafe fn unsubscribe(&self, link: Pin<&Self::Link>)

Unsafely unsubscribes a link from the notifier.

impl<T: ?Sized> Subscriber for Control<T>

fn notify(&self)

Notifies the object of a state change.