Struct Node

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

A node in a rain graph

Implementations

impl<T: ?Sized> Node<T>

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

Read the data associated with a rain node

pub fn try_data(&self) -> Option<View<RwLockReadGuard<'_, T>>>

Try to read the data associated with a rain node. Return None if the data is currently unavailable to read, i.e. there is a write occuring

use std::ops::Deref;
use rain_lang::graph::node::{Node, Data};
let node = Node::new(Data(true));
{
    let read = node.data();
    assert_eq!(read.deref(), &Data(true));
    let try_read = node.try_data().expect("Multiple reads are allowed!");
    assert_eq!(try_read.deref(), &Data(true));
}
let mut write = node.data_mut();
*write = Data(false);
assert_eq!(write.deref(), &Data(false));
assert!(node.try_data().is_none(), "Concurrent reads and writes are not allowed!");

pub fn data_mut(&self) -> View<RwLockWriteGuard<'_, T>>

Mutably get the data associated with a rain node. Note mutation is limited to operations which will not corrupt the rain graph (e.g. adding dependencies)

pub fn try_data_mut(&self) -> Option<View<RwLockWriteGuard<'_, T>>>

Try to mutably get the data associated with a rain node Return None if the data is currently unavailable to write

use std::ops::Deref;
use rain_lang::graph::node::{Node, Data};
let node = Node::new(Data(true));
{
    let mut try_write = node.try_data_mut().expect("Valid write");
    *try_write = Data(false);
}
let read = node.data();
assert_eq!(read.deref(), &Data(false));
let try_read = node.try_data().expect("Multiple reads are allowed!");
assert_eq!(try_read.deref(), &Data(false));
assert!(node.try_data_mut().is_none(), "Concurrent reads and writes are not allowed!");

pub fn downgrade(&self) -> WeakNode<T>

Downgrade this node to a weak handle

impl<T: NodeData> Node<T>

pub fn try_new(data: T) -> Result<Node<T>, T::Error>

Try to create a new node from given data, which can fail

impl<T: NodeData<Error = Infallible>> Node<T>

pub fn new(data: T) -> Node<T>

Try to create a new node from given data, which cannot fail

impl Node<ValueData>

pub fn add_dependent(&self, dependent: WeakId)

Register a value dependent on this value

Trait Implementations

impl<T: ?Sized> Clone for Node<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + ?Sized> Debug for Node<T>

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

Formats the value using the given formatter.

impl<T: Display> Display for Node<T>

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

Formats the value using the given formatter.

impl<T> HasAddr<T> for Node<T>

fn addr(&self) -> Cow<'_, Node<T>>

Get a Cow of the strong node address associated with this value

impl<T> HasThis<T> for Node<T>

fn this(&self) -> Cow<'_, WeakNode<T>>

Get a Cow of the weak node address associated with this value. May be null if there is none.

impl<T: ?Sized> Hash for Node<T>

fn hash<H: Hasher>(&self, hasher: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl JEq<Node<ValueData>> for Binary

fn jeq(&self, v: &ValId) -> bool

Check whether two objects are judgementally equal

impl JEq<Node<ValueData>> for Bool

fn jeq(&self, v: &ValId) -> bool

Check whether two objects are judgementally equal

impl JEq<Node<ValueData>> for Lambda

fn jeq(&self, v: &ValId) -> bool

Check whether two objects are judgementally equal

impl JEq<Node<ValueData>> for LogicalOp

fn jeq(&self, v: &ValId) -> bool

Check whether two objects are judgementally equal

impl JEq<Node<ValueData>> for Parameter

fn jeq(&self, v: &ValId) -> bool

Check whether two objects are judgementally equal

impl JEq<Node<ValueData>> for Sexpr

fn jeq(&self, v: &ValId) -> bool

Check whether two objects are judgementally equal

impl JEq<Node<ValueData>> for Unary

fn jeq(&self, v: &ValId) -> bool

Check whether two objects are judgementally equal

impl JEq<Node<ValueData>> for Unit

fn jeq(&self, v: &ValId) -> bool

Check whether two objects are judgementally equal

impl JEq<Node<ValueData>> for ValueEnum

fn jeq(&self, other: &ValId) -> bool

Check whether two objects are judgementally equal

impl JEq<Node<ValueData>> for bool

fn jeq(&self, v: &ValId) -> bool

Check whether two objects are judgementally equal

impl<T: ?Sized> PartialEq for Node<T>

fn eq(&self, other: &Node<T>) -> 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: ?Sized> Eq for Node<T>