Struct DataVariable

pub struct DataVariable { /* private fields */ }

Implementations

impl DataVariable

pub fn new(tp: &mut TermPool, name: &str) -> DataVariable

Create a new untyped variable with the given name.

pub fn with_sort( tp: &mut TermPool, name: &str, sort: &SortExpressionRef<'_>, ) -> DataVariable

Create a variable with the given sort and name.

pub fn name(&self) -> &str

Returns the name of the variable.

pub fn sort(&self) -> SortExpressionRef<'_>

Returns the sort of the variable.

impl DataVariable

pub fn copy<'a>(&'a self) -> DataVariableRef<'a>

Methods from Deref<Target = ATermRef<'static>>

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.

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 Borrow<ATerm> for DataVariable

fn borrow(&self) -> &ATerm

Immutably borrows from an owned value.

impl Borrow<ATermRef<'static>> for DataVariable

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

Immutably borrows from an owned value.

impl Clone for DataVariable

fn clone(&self) -> DataVariable

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DataVariable

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

Formats the value using the given formatter.

impl Default for DataVariable

fn default() -> DataVariable

Returns the “default value” for a type.

impl Deref for DataVariable

type Target = ATerm

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Display for DataVariable

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

Formats the value using the given formatter.

impl From<ATerm> for DataVariable

fn from(term: ATerm) -> DataVariable

Converts to this type from the input type.

impl From<DataVariable> for DataExpression

fn from(value: DataVariable) -> Self

Converts to this type from the input type.

impl Hash for DataVariable

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 Into<ATerm> for DataVariable

fn into(self) -> ATerm

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

impl Markable for DataVariable

fn mark(&self, todo: Todo<'_>)

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

fn cmp(&self, other: &DataVariable) -> 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 PartialEq for DataVariable

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

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

impl StructuralPartialEq for DataVariable