Symbol

Enum Symbol 

Source
pub enum Symbol {
    Const {
        name: Cow<'static, str>,
        value: Number,
        description: Option<Cow<'static, str>>,
        local: bool,
    },
    Func {
        name: Cow<'static, str>,
        args: usize,
        variadic: bool,
        callback: fn(&[Number]) -> Result<Number, FuncError>,
        description: Option<Cow<'static, str>>,
        local: bool,
    },
}
Expand description

A symbol representing either a constant or function.

Symbols are stored in a [SymTable] and referenced during evaluation.

Variants§

§

Const

Named constant (e.g., pi).

Fields

§name: Cow<'static, str>
§value: Number
§description: Option<Cow<'static, str>>
§local: bool

Whether this is a local constant (from let) or global (from stdlib)

§

Func

Function with specified arity and callback.

Fields

§name: Cow<'static, str>
§args: usize

Minimum number of arguments

§variadic: bool

Whether the function accepts additional arguments

§callback: fn(&[Number]) -> Result<Number, FuncError>
§description: Option<Cow<'static, str>>
§local: bool

Whether this is a local function (reserved for future use) or global (from stdlib)

Implementations§

Source§

impl Symbol

Source

pub fn name(&self) -> &str

Returns the name of the symbol.

Source

pub fn description(&self) -> Option<&str>

Returns the description of the symbol, if available.

Source

pub fn is_local(&self) -> bool

Returns whether this symbol is local (from let) or global (from stdlib).

Trait Implementations§

Source§

impl Clone for Symbol

Source§

fn clone(&self) -> Symbol

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Symbol

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<&Symbol> for SymbolKind

Source§

fn from(symbol: &Symbol) -> Self

Converts to this type from the input type.
Source§

impl From<&Symbol> for SymbolMetadata

Source§

fn from(symbol: &Symbol) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl Freeze for Symbol

§

impl RefUnwindSafe for Symbol

§

impl Send for Symbol

§

impl Sync for Symbol

§

impl Unpin for Symbol

§

impl UnwindSafe for Symbol

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.