Struct Reference 

pub struct Reference {
    pub ptr: DeclarationPtr,
    pub repr: Option<ReprRulePtr>,
}

A reference to a declaration (variable, parameter, etc.)

This is a thin wrapper around DeclarationPtr with two main purposes:

1. Encapsulate the serde pragmas (e.g., serializing as IDs rather than full objects)
2. Enable type-directed traversals of references via uniplate

Fields

ptr: DeclarationPtr

repr: Option<ReprRulePtr>

Implementations

impl Reference

pub fn new(ptr: DeclarationPtr) -> Self

pub fn ptr(&self) -> &DeclarationPtr

pub fn into_ptr(self) -> DeclarationPtr

pub fn name(&self) -> MappedRwLockReadGuard<'_, Name>

pub fn id(&self) -> ObjId

pub fn domain(&self) -> Option<DomainPtr>

pub fn resolved_domain(&self) -> Option<Moo<GroundDomain>>

pub fn select_repr<R: ReprRule + ?Sized>( &mut self, ) -> Result<MappedRwLockReadGuard<'_, R::DeclLevel>, ReprSelectError>

Select the given representation for this reference, if it is currently unrepresented and the representation exists for the underlying variable.

Errors

• ReprSelectError::AlreadySelected if a different representation is already selected for this reference
• ReprSelectError::DoesNotExist if the representation does not exist for this variable

Returns

State of the initialised representation

pub fn select_repr_via( &mut self, rule: ReprRulePtr, ) -> Result<MappedRwLockReadGuard<'_, dyn ReprStateStored>, ReprSelectError>

Same as Reference::select_repr, but type-erased

pub fn select_or_init_repr_via( &mut self, rule: ReprRulePtr, ) -> ReprGetOrInitResult<'_, dyn ReprStateStored, ReferenceReprError>

Same as Reference::select_or_init_repr, but type-erased

pub fn select_or_init_repr<R: ReprRule + ?Sized>( &mut self, ) -> ReprGetOrInitResult<'_, R::DeclLevel, ReferenceReprError>

Select the given representation for this reference, initialising it if necessary. Will fail if a different representation is already selected.

Errors

• ReprSelectError if a different representation is already selected for this reference
• [ReprInitError] | [ReprInstantiateError] if the representation could not be initialised

Returns

(state, symbols, constraints) where:

• state is an instance of the given representation
• symbols are new variables created by the representation
• constraints are new top-level constraints created by the representation

pub fn update_or_init_repr<R: ReprRule + ?Sized>( &mut self, ) -> ReprGetOrInitResult<'_, R::DeclLevel, ReprError>

Select the given representation for this reference, initialising it if necessary. Will overwrite the existing selection.

Errors

• [ReprInitError] | [ReprInstantiateError] if the representation could not be initialised

Returns

(state, symbols, constraints) where:

• state is an instance of the given representation
• symbols are new variables created by the representation
• constraints are new top-level constraints created by the representation

pub fn update_or_init_repr_via( &mut self, rule: ReprRulePtr, ) -> ReprGetOrInitResult<'_, dyn ReprStateStored, ReprError>

Same as Reference::update_or_init_repr, but type-erased

pub fn get_repr( &self, ) -> Option<(ReprRulePtr, MappedRwLockReadGuard<'_, dyn ReprStateStored>)>

If this reference has a representation selected, return (rule, state) where

• rule is a pointer to the representation rule
• state is an instance of that representation

pub fn get_repr_as<R: ReprRule + ?Sized>( &self, ) -> Option<MappedRwLockReadGuard<'_, R::DeclLevel>>

If this reference has this specific representation selected, get its state as a concrete type

pub fn resolve_expression(&self) -> Option<Expression>

Returns the expression behind a value-letting reference, if this is one.

Prefer Reference::with_resolved_expression when the expression only needs to be inspected. Returning an owned value here necessarily clones collection-bearing expressions such as matrix literals.

pub fn with_resolved_expression<T>( &self, inspect: impl FnOnce(&Expression) -> T, ) -> Option<T>

Calls inspect with the expression behind a value-letting reference.

The declaration is kept read-locked for the duration of inspect, allowing callers to ask questions about large value lettings without cloning them. Quantified declarations may delegate their value to an expression generator; those are handled here as well.

pub fn resolve_constant(&self) -> Option<Literal>

Evaluates this reference to a literal if it resolves to a constant.

pub fn resolve_atomic(&self) -> Option<Atom>

Resolves this reference to an atomic expression, if possible.

Trait Implementations

impl Biplate<DeclarationPtr> for Reference

fn biplate( &self, ) -> (Tree<DeclarationPtr>, Box<dyn Fn(Tree<DeclarationPtr>) -> Reference>)

Definition of a Biplate.

fn with_children_bi(&self, children: VecDeque<To>) -> Self

Reconstructs the node with the given children.

fn descend_bi(&self, op: &impl Fn(To) -> To) -> Self

Biplate variant of [Uniplate::descend]

fn universe_bi(&self) -> VecDeque<To>

Gets all children of a node, including itself and all children.

fn children_bi(&self) -> VecDeque<To>

Returns the children of a type. If to == from then it returns the original element (in contrast to children).

fn children_bi_count(&self) -> usize

Number of children that would be returned by children_bi.

fn try_replace_child_at_bi(&mut self, index: usize, child: To) -> bool

Replaces the indexth child of type To within self.

fn transform_bi(&self, op: &impl Fn(To) -> To) -> Self

Applies the given function to all nodes bottom up.

fn holes_bi(&self) -> impl Iterator<Item = (To, impl Fn(To))>

Returns an iterator over all direct children of the input, paired with a function that “fills the hole” where the child was with a new value.

fn contexts_bi(&self) -> impl Iterator<Item = (To, impl Fn(To))>

Returns an iterator over the universe of the input, paired with a function that “fills the hole” where the child was with a new value.

impl Biplate<Name> for Reference

fn biplate(&self) -> (Tree<Name>, Box<dyn Fn(Tree<Name>) -> Reference>)

Definition of a Biplate.

fn with_children_bi(&self, children: VecDeque<To>) -> Self

Reconstructs the node with the given children.

fn descend_bi(&self, op: &impl Fn(To) -> To) -> Self

Biplate variant of [Uniplate::descend]

fn universe_bi(&self) -> VecDeque<To>

Gets all children of a node, including itself and all children.

fn children_bi(&self) -> VecDeque<To>

Returns the children of a type. If to == from then it returns the original element (in contrast to children).

fn children_bi_count(&self) -> usize

Number of children that would be returned by children_bi.

fn try_replace_child_at_bi(&mut self, index: usize, child: To) -> bool

Replaces the indexth child of type To within self.

fn transform_bi(&self, op: &impl Fn(To) -> To) -> Self

Applies the given function to all nodes bottom up.

fn holes_bi(&self) -> impl Iterator<Item = (To, impl Fn(To))>

Returns an iterator over all direct children of the input, paired with a function that “fills the hole” where the child was with a new value.

fn contexts_bi(&self) -> impl Iterator<Item = (To, impl Fn(To))>

Returns an iterator over the universe of the input, paired with a function that “fills the hole” where the child was with a new value.

impl Biplate<Reference> for Atom

fn biplate(&self) -> (Tree<Reference>, Box<dyn Fn(Tree<Reference>) -> Atom>)

Definition of a Biplate.

fn with_children_bi(&self, children: VecDeque<To>) -> Self

Reconstructs the node with the given children.

fn descend_bi(&self, op: &impl Fn(To) -> To) -> Self

Biplate variant of [Uniplate::descend]

fn universe_bi(&self) -> VecDeque<To>

Gets all children of a node, including itself and all children.

fn children_bi(&self) -> VecDeque<To>

Returns the children of a type. If to == from then it returns the original element (in contrast to children).

fn children_bi_count(&self) -> usize

Number of children that would be returned by children_bi.

fn try_replace_child_at_bi(&mut self, index: usize, child: To) -> bool

Replaces the indexth child of type To within self.

fn transform_bi(&self, op: &impl Fn(To) -> To) -> Self

Applies the given function to all nodes bottom up.

fn holes_bi(&self) -> impl Iterator<Item = (To, impl Fn(To))>

Returns an iterator over all direct children of the input, paired with a function that “fills the hole” where the child was with a new value.

fn contexts_bi(&self) -> impl Iterator<Item = (To, impl Fn(To))>

Returns an iterator over the universe of the input, paired with a function that “fills the hole” where the child was with a new value.

impl Biplate<Reference> for DeclarationPtr

fn biplate(&self) -> (Tree<Reference>, Box<dyn Fn(Tree<Reference>) -> Self>)

Definition of a Biplate.

fn with_children_bi(&self, children: VecDeque<To>) -> Self

Reconstructs the node with the given children.

fn descend_bi(&self, op: &impl Fn(To) -> To) -> Self

Biplate variant of [Uniplate::descend]

fn universe_bi(&self) -> VecDeque<To>

Gets all children of a node, including itself and all children.

fn children_bi(&self) -> VecDeque<To>

Returns the children of a type. If to == from then it returns the original element (in contrast to children).

fn children_bi_count(&self) -> usize

Number of children that would be returned by children_bi.

fn try_replace_child_at_bi(&mut self, index: usize, child: To) -> bool

Replaces the indexth child of type To within self.

fn transform_bi(&self, op: &impl Fn(To) -> To) -> Self

Applies the given function to all nodes bottom up.

fn holes_bi(&self) -> impl Iterator<Item = (To, impl Fn(To))>

Returns an iterator over all direct children of the input, paired with a function that “fills the hole” where the child was with a new value.

fn contexts_bi(&self) -> impl Iterator<Item = (To, impl Fn(To))>

Returns an iterator over the universe of the input, paired with a function that “fills the hole” where the child was with a new value.

impl Biplate<Reference> for Domain

fn biplate(&self) -> (Tree<Reference>, Box<dyn Fn(Tree<Reference>) -> Domain>)

Definition of a Biplate.

fn with_children_bi(&self, children: VecDeque<To>) -> Self

Reconstructs the node with the given children.

fn descend_bi(&self, op: &impl Fn(To) -> To) -> Self

Biplate variant of [Uniplate::descend]

fn universe_bi(&self) -> VecDeque<To>

Gets all children of a node, including itself and all children.

fn children_bi(&self) -> VecDeque<To>

Returns the children of a type. If to == from then it returns the original element (in contrast to children).

fn children_bi_count(&self) -> usize

Number of children that would be returned by children_bi.

fn try_replace_child_at_bi(&mut self, index: usize, child: To) -> bool

Replaces the indexth child of type To within self.

fn transform_bi(&self, op: &impl Fn(To) -> To) -> Self

Applies the given function to all nodes bottom up.

fn holes_bi(&self) -> impl Iterator<Item = (To, impl Fn(To))>

Returns an iterator over all direct children of the input, paired with a function that “fills the hole” where the child was with a new value.

fn contexts_bi(&self) -> impl Iterator<Item = (To, impl Fn(To))>

Returns an iterator over the universe of the input, paired with a function that “fills the hole” where the child was with a new value.

impl Biplate<Reference> for IntVal

fn biplate(&self) -> (Tree<Reference>, Box<dyn Fn(Tree<Reference>) -> IntVal>)

Definition of a Biplate.

fn with_children_bi(&self, children: VecDeque<To>) -> Self

Reconstructs the node with the given children.

fn descend_bi(&self, op: &impl Fn(To) -> To) -> Self

Biplate variant of [Uniplate::descend]

fn universe_bi(&self) -> VecDeque<To>

Gets all children of a node, including itself and all children.

fn children_bi(&self) -> VecDeque<To>

Returns the children of a type. If to == from then it returns the original element (in contrast to children).

fn children_bi_count(&self) -> usize

Number of children that would be returned by children_bi.

fn try_replace_child_at_bi(&mut self, index: usize, child: To) -> bool

Replaces the indexth child of type To within self.

fn transform_bi(&self, op: &impl Fn(To) -> To) -> Self

Applies the given function to all nodes bottom up.

fn holes_bi(&self) -> impl Iterator<Item = (To, impl Fn(To))>

Returns an iterator over all direct children of the input, paired with a function that “fills the hole” where the child was with a new value.

fn contexts_bi(&self) -> impl Iterator<Item = (To, impl Fn(To))>

Returns an iterator over the universe of the input, paired with a function that “fills the hole” where the child was with a new value.

impl Biplate<Reference> for UnresolvedDomain

fn biplate( &self, ) -> (Tree<Reference>, Box<dyn Fn(Tree<Reference>) -> UnresolvedDomain>)

Definition of a Biplate.

fn with_children_bi(&self, children: VecDeque<To>) -> Self

Reconstructs the node with the given children.

fn descend_bi(&self, op: &impl Fn(To) -> To) -> Self

Biplate variant of [Uniplate::descend]

fn universe_bi(&self) -> VecDeque<To>

Gets all children of a node, including itself and all children.

fn children_bi(&self) -> VecDeque<To>

Returns the children of a type. If to == from then it returns the original element (in contrast to children).

fn children_bi_count(&self) -> usize

Number of children that would be returned by children_bi.

fn try_replace_child_at_bi(&mut self, index: usize, child: To) -> bool

Replaces the indexth child of type To within self.

fn transform_bi(&self, op: &impl Fn(To) -> To) -> Self

Applies the given function to all nodes bottom up.

fn holes_bi(&self) -> impl Iterator<Item = (To, impl Fn(To))>

Returns an iterator over all direct children of the input, paired with a function that “fills the hole” where the child was with a new value.

fn contexts_bi(&self) -> impl Iterator<Item = (To, impl Fn(To))>

Returns an iterator over the universe of the input, paired with a function that “fills the hole” where the child was with a new value.

impl Biplate<Reference> for Expression

fn biplate( &self, ) -> (Tree<Reference>, Box<dyn Fn(Tree<Reference>) -> Expression>)

Definition of a Biplate.

fn with_children_bi(&self, children: VecDeque<To>) -> Self

Reconstructs the node with the given children.

fn descend_bi(&self, op: &impl Fn(To) -> To) -> Self

Biplate variant of [Uniplate::descend]

fn universe_bi(&self) -> VecDeque<To>

Gets all children of a node, including itself and all children.

fn children_bi(&self) -> VecDeque<To>

Returns the children of a type. If to == from then it returns the original element (in contrast to children).

fn children_bi_count(&self) -> usize

Number of children that would be returned by children_bi.

fn try_replace_child_at_bi(&mut self, index: usize, child: To) -> bool

Replaces the indexth child of type To within self.

fn transform_bi(&self, op: &impl Fn(To) -> To) -> Self

Applies the given function to all nodes bottom up.

fn holes_bi(&self) -> impl Iterator<Item = (To, impl Fn(To))>

Returns an iterator over all direct children of the input, paired with a function that “fills the hole” where the child was with a new value.

fn contexts_bi(&self) -> impl Iterator<Item = (To, impl Fn(To))>

Returns an iterator over the universe of the input, paired with a function that “fills the hole” where the child was with a new value.

impl Biplate<Reference> for Reference

fn biplate( &self, ) -> (Tree<Reference>, Box<dyn Fn(Tree<Reference>) -> Reference>)

Definition of a Biplate.

fn children_bi_count(&self) -> usize

Number of children that would be returned by children_bi.

fn try_replace_child_at_bi(&mut self, index: usize, child: Reference) -> bool

Replaces the indexth child of type To within self.

fn with_children_bi(&self, children: VecDeque<To>) -> Self

Reconstructs the node with the given children.

fn descend_bi(&self, op: &impl Fn(To) -> To) -> Self

Biplate variant of [Uniplate::descend]

fn universe_bi(&self) -> VecDeque<To>

Gets all children of a node, including itself and all children.

fn children_bi(&self) -> VecDeque<To>

Returns the children of a type. If to == from then it returns the original element (in contrast to children).

fn transform_bi(&self, op: &impl Fn(To) -> To) -> Self

Applies the given function to all nodes bottom up.

fn holes_bi(&self) -> impl Iterator<Item = (To, impl Fn(To))>

Returns an iterator over all direct children of the input, paired with a function that “fills the hole” where the child was with a new value.

fn contexts_bi(&self) -> impl Iterator<Item = (To, impl Fn(To))>

Returns an iterator over the universe of the input, paired with a function that “fills the hole” where the child was with a new value.

impl CategoryOf for Reference

fn category_of(&self) -> Category

Gets the Category of a term.

impl Clone for Reference

fn clone(&self) -> Reference

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Reference

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Reference

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Reference

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

Formats the value using the given formatter.

impl Eq for Reference

impl From<DeclarationPtr> for Reference

fn from(ptr: DeclarationPtr) -> Self

Converts to this type from the input type.

impl From<Reference> for Atom

fn from(value: Reference) -> Self

Converts to this type from the input type.

impl From<Reference> for Expression

fn from(value: Reference) -> Self

Converts to this type from the input type.

impl From<Reference> for Moo<Expression>

fn from(value: Reference) -> Self

Converts to this type from the input type.

impl HasDomain for Reference

fn domain_of(&self) -> DomainPtr

Gets the Domain of self.

impl Hash for Reference

fn hash<__H>(&self, __state: &mut __H)

where __H: Hasher,

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 Ord for Reference

fn cmp(&self, other: &Reference) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Reference

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Reference

fn partial_cmp(&self, other: &Reference) -> 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 Serialize for Reference

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Reference

impl Uniplate for Reference

fn uniplate( &self, ) -> (Tree<Reference>, Box<dyn Fn(Tree<Reference>) -> Reference>)

Definition of a Uniplate.

fn try_replace_child_at(&mut self, index: usize, child: Reference) -> bool

Replaces the indexth direct child of self.

fn descend(&self, op: &impl Fn(Self) -> Self) -> Self

Applies a function to all direct children of this

fn universe(&self) -> VecDeque<Self>

Gets all children of a node, including itself and all children.

fn children(&self) -> VecDeque<Self>

Gets the direct children (maximal substructures) of a node.

fn with_children(&self, children: VecDeque<Self>) -> Self

Reconstructs the node with the given children.

fn transform(&self, f: &impl Fn(Self) -> Self) -> Self

Applies the given function to all nodes bottom up.

fn rewrite(&self, f: &impl Fn(Self) -> Option<Self>) -> Self

Rewrites by applying a rule everywhere it can.

fn cata<T>(&self, op: &impl Fn(Self, VecDeque<T>) -> T) -> T

Performs a fold-like computation on each value.

fn holes(&self) -> impl Iterator<Item = (Self, impl Fn(Self))>

Returns an iterator over all direct children of the input, paired with a function that “fills the hole” where the child was with a new value.

fn contexts(&self) -> impl Iterator<Item = (Self, impl Fn(Self))>

Returns an iterator over the universe of the input, paired with a function that “fills the hole” where the child was with a new value.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 24 bytes