Struct ValueData

pub struct ValueData {
    pub value: ValueEnum,
    pub name: Option<String>,
    pub region: WeakRegion,
    /* private fields */
}

The data associated with a rain value

Fields

value: ValueEnum

The value itself

name: Option<String>

The name associated with this value, if any

region: WeakRegion

The region this value is defined in

Implementations

impl ValueData

pub fn with_region(value: ValueEnum, region: WeakRegion) -> ValueData

Create ValueData from a ValueEnum having a given region

pub fn new(value: ValueEnum) -> ValueData

Create ValueData from a ValueEnum with no region

pub fn add_dependent(&mut self, dependent: WeakNode<Self>)

Add a dependent to a value

pub fn dependencies(&self) -> Dependencies<'_>

Iterate over the direct dependencies for the given node

pub fn dependents(&self) -> &[WeakId]

Get the direct dependents of a given node

Methods from Deref<Target = ValueEnum>

pub fn applicable(&self) -> bool

Check whether this value enum variant can potentially be applied

pub fn name_print( &self, fmt: &mut Formatter<'_>, name: Option<&str>, ) -> Result<(), Error>

Print a value with a name

pub fn base_region(&self) -> Cow<'_, WeakRegion>

Get the base region of this ValueEnum

Trait Implementations

impl<V> CacheBy<V> for ValueData

where V: ValueDesc + Hash,

type CacheError = <V as ValueDesc>::Err

Potential error when trying to cache a key type

fn node_to_cache(key: V) -> Result<ValId, V::Err>

Try to get the node to cache for a given key

impl Clone for ValueData

fn clone(&self) -> ValueData

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ValueData

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

Formats the value using the given formatter.

impl Display for ValueData

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

Formats the value using the given formatter.

impl From<Binary> for ValueData

fn from(p: Binary) -> ValueData

Converts to this type from the input type.

impl From<Bool> for ValueData

fn from(p: Bool) -> ValueData

Converts to this type from the input type.

impl From<Lambda> for ValueData

fn from(lambda: Lambda) -> ValueData

Converts to this type from the input type.

impl From<LogicalOp> for ValueData

fn from(p: LogicalOp) -> ValueData

Converts to this type from the input type.

impl From<Parameter> for ValueData

fn from(param: Parameter) -> ValueData

Converts to this type from the input type.

impl From<Sexpr> for ValueData

fn from(sexpr: Sexpr) -> ValueData

Converts to this type from the input type.

impl From<Unary> for ValueData

fn from(p: Unary) -> ValueData

Converts to this type from the input type.

impl From<Unit> for ValueData

fn from(p: Unit) -> ValueData

Converts to this type from the input type.

impl From<ValueEnum> for ValueData

fn from(value: ValueEnum) -> ValueData

Converts to this type from the input type.

impl From<bool> for ValueData

fn from(p: bool) -> ValueData

Converts to this type from the input type.

impl Hash for ValueData

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 NodeData for ValueData

type Error = ValueError

A possible error in placing an item into a node or deduplicating

type CacheAcceptor = Entry<'static, u64, WeakNode<ValueData>, BuildHasherDefault<PassThroughHasher>>

An acceptor for cache entries

fn backlink( &mut self, backlink: Backlink<'_, ValueData>, ) -> Result<(), ValueError>

Backlink this data to the given node. Warning: Any attempt to read the data of backlink in this function will lead to deadlock! Backlinking should not create new nodes if dedup obtains a lock on the cache table!

fn dedup(&mut self) -> Either<ValId, CacheEntry<'static, ValueData>>

Attempt to deduplicate this NodeData, either succeeding or returning a cache entry to place the newly created node in should backlinking succeed.

impl PartialEq for ValueData

fn eq(&self, other: &ValueData) -> 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 TryFrom<SexprArgs> for ValueData

type Error = ValueError

The type returned in the event of a conversion error.

fn try_from(args: SexprArgs) -> Result<ValueData, ValueError>

Performs the conversion.

impl Deref for ValueData

type Target = ValueEnum

The resulting type after dereferencing.

fn deref(&self) -> &ValueEnum

Dereferences the value.