Struct Backlink

pub struct Backlink<'a, T>(/* private fields */);

A backlink to a node

Methods from Deref<Target = 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

Trait Implementations

impl<'a, T: Clone> Clone for Backlink<'a, T>

fn clone(&self) -> Backlink<'a, T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, T: Debug> Debug for Backlink<'a, T>

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

Formats the value using the given formatter.

impl<T> Deref for Backlink<'_, T>

type Target = Node<T>

The resulting type after dereferencing.

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

Dereferences the value.