Struct Symbol 

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

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) -> Symbol

Construct a symbol from input — stored verbatim, no validation.

Any string is accepted: a fully-qualified "System`Plus", a context-less "Plus", or anything else. What goes into a symbol is the caller’s business — we don’t police WL symbol syntax. A name the kernel can’t make sense of is the caller’s problem, not ours.

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

Use Symbol::try_new if you want to validate the name first.

Examples found in repository

examples/wstp.rs (line 182)

fn expr_string_join(link: &mut Link) {
    let expr = link.get_expr().unwrap();

    let ExprKind::Normal(list) = expr.kind() else {
        panic!("expected a List, got: {:?}", expr);
    };
    assert!(list.has_head(&Symbol::new("System`List")));

    let mut buffer = String::new();
    for elem in list.elements() {
        match elem.kind() {
            ExprKind::String(str) => buffer.push_str(str),
            _ => panic!("expected String argument, got: {:?}", elem),
        }
    }

    link.put_str(buffer.as_str()).unwrap()
}

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 duplicate 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<(), Error>

Formats the value using the given formatter.

impl Display for Symbol

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

Formats the value using the given formatter.

impl Eq for Symbol

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) -> Symbol

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<'de> FromWXF<'de> for Symbol

fn from_wxf<R>(r: &mut WxfReader<R>) -> Result<Self, Error>

where R: Reader<'de>,

Read a complete value: its expression token, then its body.

impl Hash for Symbol

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<Symbol> for Expr

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

Equality operator ==.

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

Inequality operator !=.

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

impl ToWXF for Symbol

fn to_wxf<W>(&self, w: &mut WxfWriter<W>) -> Result<(), Error>

where W: Writer,

Write self to w as a complete WXF value (tag + payload).

impl<'e> TryFrom<&'e Expr> for &'e Symbol

fn try_from(expr: &'e Expr) -> Result<&'e Symbol, &'e Expr>

If this is a Symbol expression, return that.

let expr = expr!(System::Pi);
let sym = <&Symbol>::try_from(&expr).unwrap();
assert_eq!(sym.as_str(), "System`Pi");

type Error = &'e Expr

The type returned in the event of a conversion error.