Struct Variable

pub struct Variable<T>
where
    T: Send + Sync,
{ /* private fields */ }

A variable. When the value is changed, it will update the computation.

Variable are created like this:

let v1: Variable<i32> = 1.into();
let v2 = Variable::<u32>::new(2);

Implementations

impl<T> Variable<T>

where T: Send + Sync,

pub fn new(t: T) -> Self

Create a new variable with a given default value.

pub fn set(&self, t: T)

Set the value of the variable.

pub fn read_value(&self) -> RwLockReadGuard<'_, T>

Get the value as a ref (keep the value locked)

pub fn ro_value(&self) -> RoLock<T>

Get the inner locked value

pub fn update(&self, f: impl Fn(&mut T))

Update the value. The function f receive a reference to the value.

Trait Implementations

impl<T> Debug for Variable<T>

where T: Send + Sync + Debug,

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

Formats the value using the given formatter.

impl<T> Default for Variable<T>

where T: Default + Send + Sync,

fn default() -> Self

Returns the “default value” for a type.

impl<T> From<T> for Variable<T>

where T: Send + Sync,

fn from(value: T) -> Self

Converts to this type from the input type.

impl<T> PartialEq<T> for Variable<T>

where T: PartialEq + Send + Sync,

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

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

const 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> PartialEq for Variable<T>

where T: PartialEq + Send + Sync,

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

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

const 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> PartialOrd<T> for Variable<T>

where T: PartialOrd + Send + Sync,

fn partial_cmp(&self, other: &T) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> PartialOrd for Variable<T>

where T: PartialOrd + Send + Sync,

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.