Struct SymbolRef

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

Implementations

impl<'a> SymbolRef<'a>

A Symbol references to an aterm function symbol, which has a name and an arity.

pub fn protect(&self) -> Symbol

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

impl SymbolRef<'_>

pub fn name(&self) -> &str

Obtain the symbol’s name

pub fn arity(&self) -> usize

Obtain the symbol’s arity

pub fn address(&self) -> *const _function_symbol

Returns the index of the function symbol

Trait Implementations

impl Borrow<SymbolRef<'static>> for Symbol

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

Immutably borrows from an owned value.

impl Debug for SymbolRef<'_>

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

Formats the value using the given formatter.

impl Display for SymbolRef<'_>

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

Formats the value using the given formatter.

impl From<&SymbolRef<'_>> for Symbol

fn from(value: &SymbolRef<'_>) -> Self

Converts to this type from the input type.

impl From<*const _function_symbol> for SymbolRef<'_>

fn from(symbol: *const _function_symbol) -> Self

Converts to this type from the input type.

impl<'a> Hash for SymbolRef<'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> Ord for SymbolRef<'a>

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

fn eq(&self, other: &SymbolRef<'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 SymbolRef<'a>

fn partial_cmp(&self, other: &SymbolRef<'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 SymbolRef<'a>

impl<'a> StructuralPartialEq for SymbolRef<'a>