Struct ATermRef

pub struct ATermRef<'a> { /* private fields */ }

This represents a lifetime bound reference to an existing ATerm that is protected somewhere statically.

Can be ’static if the term is protected in a container or ATerm. That means we either return &’a ATermRef<’static> or with a concrete lifetime ATermRef<’a>. However, this means that the functions for ATermRef cannot use the associated lifetime for the results parameters, as that would allow us to acquire the ’static lifetime. This occasionally gives rise to issues where we look at the argument of a term and want to return it’s name, but this is not allowed since the temporary returned by the argument is dropped.

Implementations

impl<'a> ATermRef<'a>

pub fn protect(&self) -> ATerm

Protects the reference on the thread local protection pool.

pub fn protect_global(&self) -> ATermGlobal

Protects the reference on the global protection pool.

pub fn upgrade<'b: 'a>(&'a self, parent: &ATermRef<'b>) -> ATermRef<'b>

This allows us to extend our borrowed lifetime from ’a to ’b based on existing parent term which has lifetime ’b.

The main usecase is to establish transitive lifetimes. For example given a term t from which we borrow u = t.arg(0) then we cannot have u.arg(0) live as long as t since the intermediate temporary u is dropped. However, since we know that u.arg(0) is a subterm of t we can upgrade its lifetime to the lifetime of t using this function.

Safety

This function might only be used if witness is a parent term of the current term.

impl ATermRef<'_>

pub fn arg(&self, index: usize) -> ATermRef<'_>

Returns the indexed argument of the term

pub fn arguments(&self) -> ATermArgs<'_>

Returns the list of arguments as a collection

pub fn copy(&self) -> ATermRef<'_>

Makes a copy of the term with the same lifetime as itself.

pub fn is_default(&self) -> bool

Returns whether the term is the default term (not initialised)

pub fn is_list(&self) -> bool

Returns true iff this is an aterm_list

pub fn is_empty_list(&self) -> bool

Returns true iff this is the empty aterm_list

pub fn is_int(&self) -> bool

Returns true iff this is a aterm_int

pub fn get_head_symbol(&self) -> SymbolRef<'_>

Returns the head function symbol of the term.

pub fn iter(&self) -> TermIterator<'_>

Returns an iterator over all arguments of the term that runs in pre order traversal of the term trees.

pub fn require_valid(&self)

Panics if the term is default

Trait Implementations

impl<'a> Borrow<ATermRef<'a>> for ATerm

fn borrow(&self) -> &ATermRef<'a>

Immutably borrows from an owned value.

impl<'a> Borrow<ATermRef<'a>> for BasicSortRef<'a>

fn borrow(&self) -> &ATermRef<'a>

Immutably borrows from an owned value.

impl<'a> Borrow<ATermRef<'a>> for BoolSortRef<'a>

fn borrow(&self) -> &ATermRef<'a>

Immutably borrows from an owned value.

impl<'a> Borrow<ATermRef<'a>> for DataApplicationRef<'a>

fn borrow(&self) -> &ATermRef<'a>

Immutably borrows from an owned value.

impl<'a> Borrow<ATermRef<'a>> for DataExpressionRef<'a>

fn borrow(&self) -> &ATermRef<'a>

Immutably borrows from an owned value.

impl<'a> Borrow<ATermRef<'a>> for DataFunctionSymbolRef<'a>

fn borrow(&self) -> &ATermRef<'a>

Immutably borrows from an owned value.

impl<'a> Borrow<ATermRef<'a>> for DataVariableRef<'a>

fn borrow(&self) -> &ATermRef<'a>

Immutably borrows from an owned value.

impl<'a> Borrow<ATermRef<'a>> for FunctionSortRef<'a>

fn borrow(&self) -> &ATermRef<'a>

Immutably borrows from an owned value.

impl<'a> Borrow<ATermRef<'a>> for MachineNumberRef<'a>

fn borrow(&self) -> &ATermRef<'a>

Immutably borrows from an owned value.

impl<'a> Borrow<ATermRef<'a>> for SortExpressionRef<'a>

fn borrow(&self) -> &ATermRef<'a>

Immutably borrows from an owned value.

impl Borrow<ATermRef<'static>> for BasicSort

fn borrow(&self) -> &ATermRef<'static>

Immutably borrows from an owned value.

impl Borrow<ATermRef<'static>> for BoolSort

fn borrow(&self) -> &ATermRef<'static>

Immutably borrows from an owned value.

impl Borrow<ATermRef<'static>> for DataApplication

fn borrow(&self) -> &ATermRef<'static>

Immutably borrows from an owned value.

impl Borrow<ATermRef<'static>> for DataExpression

fn borrow(&self) -> &ATermRef<'static>

Immutably borrows from an owned value.

impl Borrow<ATermRef<'static>> for DataFunctionSymbol

fn borrow(&self) -> &ATermRef<'static>

Immutably borrows from an owned value.

impl Borrow<ATermRef<'static>> for DataVariable

fn borrow(&self) -> &ATermRef<'static>

Immutably borrows from an owned value.

impl Borrow<ATermRef<'static>> for FunctionSort

fn borrow(&self) -> &ATermRef<'static>

Immutably borrows from an owned value.

impl Borrow<ATermRef<'static>> for SortExpression

fn borrow(&self) -> &ATermRef<'static>

Immutably borrows from an owned value.

impl Debug for ATermRef<'_>

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

Formats the value using the given formatter.

impl Default for ATermRef<'_>

fn default() -> Self

Returns the “default value” for a type.

impl Display for ATermRef<'_>

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

Formats the value using the given formatter.

impl<'a, T> From<ATermRef<'a>> for ATermList<T>

fn from(value: ATermRef<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<ATermRef<'a>> for BasicSortRef<'a>

fn from(term: ATermRef<'a>) -> BasicSortRef<'a>

Converts to this type from the input type.

impl<'a> From<ATermRef<'a>> for BoolSortRef<'a>

fn from(term: ATermRef<'a>) -> BoolSortRef<'a>

Converts to this type from the input type.

impl<'a> From<ATermRef<'a>> for DataApplicationRef<'a>

fn from(term: ATermRef<'a>) -> DataApplicationRef<'a>

Converts to this type from the input type.

impl<'a> From<ATermRef<'a>> for DataExpressionRef<'a>

fn from(term: ATermRef<'a>) -> DataExpressionRef<'a>

Converts to this type from the input type.

impl<'a> From<ATermRef<'a>> for DataFunctionSymbolRef<'a>

fn from(term: ATermRef<'a>) -> DataFunctionSymbolRef<'a>

Converts to this type from the input type.

impl<'a> From<ATermRef<'a>> for DataVariableRef<'a>

fn from(term: ATermRef<'a>) -> DataVariableRef<'a>

Converts to this type from the input type.

impl<'a> From<ATermRef<'a>> for FunctionSortRef<'a>

fn from(term: ATermRef<'a>) -> FunctionSortRef<'a>

Converts to this type from the input type.

impl<'a> From<ATermRef<'a>> for MachineNumberRef<'a>

fn from(term: ATermRef<'a>) -> MachineNumberRef<'a>

Converts to this type from the input type.

impl<'a> From<ATermRef<'a>> for SortExpressionRef<'a>

fn from(term: ATermRef<'a>) -> SortExpressionRef<'a>

Converts to this type from the input type.

impl<'a> Hash for ATermRef<'a>

fn hash<__H: Hasher>(&self, state: &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<'a> Into<ATermRef<'a>> for BasicSortRef<'a>

fn into(self) -> ATermRef<'a>

Converts this type into the (usually inferred) input type.

impl<'a> Into<ATermRef<'a>> for BoolSortRef<'a>

fn into(self) -> ATermRef<'a>

Converts this type into the (usually inferred) input type.

impl<'a> Into<ATermRef<'a>> for DataApplicationRef<'a>

fn into(self) -> ATermRef<'a>

Converts this type into the (usually inferred) input type.

impl<'a> Into<ATermRef<'a>> for DataExpressionRef<'a>

fn into(self) -> ATermRef<'a>

Converts this type into the (usually inferred) input type.

impl<'a> Into<ATermRef<'a>> for DataFunctionSymbolRef<'a>

fn into(self) -> ATermRef<'a>

Converts this type into the (usually inferred) input type.

impl<'a> Into<ATermRef<'a>> for DataVariableRef<'a>

fn into(self) -> ATermRef<'a>

Converts this type into the (usually inferred) input type.

impl<'a> Into<ATermRef<'a>> for FunctionSortRef<'a>

fn into(self) -> ATermRef<'a>

Converts this type into the (usually inferred) input type.

impl<'a> Into<ATermRef<'a>> for MachineNumberRef<'a>

fn into(self) -> ATermRef<'a>

Converts this type into the (usually inferred) input type.

impl<'a> Into<ATermRef<'a>> for SortExpressionRef<'a>

fn into(self) -> ATermRef<'a>

Converts this type into the (usually inferred) input type.

impl Markable for ATermRef<'_>

fn mark(&self, todo: Pin<&mut term_mark_stack>)

Marks all the ATermRefs to prevent them from being garbage collected.

fn contains_term(&self, term: &ATermRef<'_>) -> bool

Should return true iff the given term is contained in the object. Used for runtime checks.

fn len(&self) -> usize

Returns the number of terms in the instance, used to delay garbage collection.

fn is_empty(&self) -> bool

Returns true iff the container is empty.

impl<'a> Ord for ATermRef<'a>

fn cmp(&self, other: &ATermRef<'a>) -> 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.

impl<'a> PartialEq for ATermRef<'a>

fn eq(&self, other: &ATermRef<'a>) -> 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<'a> PartialOrd for ATermRef<'a>

fn partial_cmp(&self, other: &ATermRef<'a>) -> 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<'a> Eq for ATermRef<'a>

impl Send for ATermRef<'_>

These are safe because terms are never modified. Garbage collection is always performed with exclusive access and uses relaxed atomics to perform some interior mutability.

impl<'a> StructuralPartialEq for ATermRef<'a>

impl Sync for ATermRef<'_>