Struct Symbol

#[repr(C)]
pub struct Symbol(/* private fields */);

Wolfram Language symbol.

PartialOrd sorting order

The comparison behavior of this type is NOT guaranteed to match the behavior of System`Order for symbols (and does not match it at the moment).

This type implements PartialOrd/Ord primarily for the purposes of allowing instances of this type to be included in ordered sets (e.g. BTreeMap).

Implementations

impl Symbol

pub fn try_new(input: &str) -> Option<Self>

Attempt to parse input as an absolute symbol.

An absolute symbol is a symbol with an explicit context path. "System`Plus" is an absolute symbol, "Plus" is a relative symbol and/or a SymbolName. "`Plus" is also a relative symbol.

pub fn new(input: &str) -> Self

Construct a symbol from input.

Panics

This function will panic if input is not a valid Wolfram Language symbol. Symbol::try_new(input) must succeed.

This method is intended to be used for convenient construction of symbols from string literals, where an error is unlikely to occur, e.g.:

let expr = Expr::normal(Symbol::new("MyPackage`Foo"), vec![]);

If not using a string literal as the argument, prefer to use Symbol::try_new and handle the error condition.

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

Get a borrowed SymbolRef from this Symbol.

pub fn context(&self) -> ContextRef<'_>

Get the context path part of a symbol as an ContextRef.

pub fn symbol_name(&self) -> SymbolNameRef<'_>

Get the symbol name part of a symbol as a SymbolNameRef.

impl Symbol

pub fn as_str(&self) -> &str

Get the underlying &str representation of this type.

Trait Implementations

impl Clone for Symbol

fn clone(&self) -> Symbol

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Symbol

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

Formats the value using the given formatter.

impl Display for Symbol

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

Formats the value using the given formatter.

impl From<&Symbol> for Expr

fn from(sym: &Symbol) -> Expr

Converts to this type from the input type.

impl From<&Symbol> for Symbol

fn from(sym: &Symbol) -> Self

Converts to this type from the input type.

impl From<Symbol> for Expr

fn from(sym: Symbol) -> Expr

Converts to this type from the input type.

impl Hash for Symbol

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

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

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

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

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

impl StructuralPartialEq for Symbol