Struct wolfram_expr::symbol::SymbolRef

pub struct SymbolRef<'s>(_);

Borrowed string containing a valid symbol.

Implementations

impl<'s> SymbolRef<'s>

pub fn try_new(string: &'s str) -> Option<Self>

Attempt to parse string as an absolute symbol.

Examples

use wolfram_expr::symbol::SymbolRef;

assert!(matches!(SymbolRef::try_new("System`List"), Some(_)));
assert!(matches!(SymbolRef::try_new("List"), None));
assert!(matches!(SymbolRef::try_new("123"), None));

pub fn as_str(&self) -> &'s str

Get the borrowed string data.

pub fn to_symbol(&self) -> Symbol

Convert this borrowed string into an owned Symbol.

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

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

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

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

Trait Implementations

impl<'s> Clone for SymbolRef<'s>

fn clone(&self) -> SymbolRef<'s>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'s> Debug for SymbolRef<'s>

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

Formats the value using the given formatter.

impl<'s> Hash for SymbolRef<'s>

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<'s> Ord for SymbolRef<'s>

fn cmp(&self, other: &SymbolRef<'s>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<'s> PartialEq<SymbolRef<'s>> for SymbolRef<'s>

fn eq(&self, other: &SymbolRef<'s>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'s> PartialOrd<SymbolRef<'s>> for SymbolRef<'s>

fn partial_cmp(&self, other: &SymbolRef<'s>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'s> Copy for SymbolRef<'s>

impl<'s> Eq for SymbolRef<'s>

impl<'s> StructuralEq for SymbolRef<'s>

impl<'s> StructuralPartialEq for SymbolRef<'s>