Struct Reference

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

Reference to a Variable, Computation… Allows to change an input to a computation.

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

let mut ref1 = Reference::<i32>::new(&v1);

// `c1` is initialized to use `v1` as input.
let c1 = Computation::<i32>::new(|(x,)| *x, (&ref1,));
println!("{} == 1", *c1.read_result());

// After this call `c1` will use `v2` as input.
ref1.replace(&v2);
println!("{} == 2", *c1.read_result());

Implementations

impl<T> Reference<T>

where T: Sync + Send + 'static,

pub fn new<TVar>(tvar: &TVar) -> Self

where TVar: ComputationInputInterface<Type = T>, for<'a> <<TVar as ComputationInputInterface>::InputReaderType as InputReader<T>>::InputGuard<'a>: Deref<Target = T>,

Create a new reference with the given formula.

pub fn read_value<'a>(&'a self) -> impl Deref<Target = T> + 'a

Get the result of the referenced variable.

pub fn replace<TVar>(&mut self, tvar: &TVar)

where TVar: ComputationInputInterface<Type = T>, for<'a> <<TVar as ComputationInputInterface>::InputReaderType as InputReader<T>>::InputGuard<'a>: Deref<Target = T>,

Replace the variable in the reference

Trait Implementations

impl<T> Debug for Reference<T>

where T: Send + Sync + 'static + Debug,

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

Formats the value using the given formatter.

impl<T> PartialEq<T> for Reference<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 Reference<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 Reference<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 Reference<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.