Struct jlrs::value::symbol::Symbol

#[repr(transparent)]pub struct Symbol<'base>(_, _);

Symbols are used Julia to represent identifiers, :x represents the Symbol x. Things that can be accessed using a Symbol include submodules, functions, and globals. However, the methods that provide this functionality in jlrs can use strings instead.

This struct implements JuliaTypecheck and Cast. It can be used in combination with DataType::is and Value::is; if the check returns true the Value can be cast to Symbol:

julia.frame(2, |global, frame| {
    let symbol_func = Module::core(global).function("Symbol")?;
    let symbol_str = Value::new(frame, "+")?;
    let symbol_val = symbol_func.call1(frame, symbol_str)?.unwrap();
    assert!(symbol_val.is::<Symbol>());

    let symbol = symbol_val.cast::<Symbol>()?;
    assert!(Module::base(global).function(symbol).is_ok());
    Ok(())
}).unwrap();

Implementations

impl<'base> Symbol<'base>

pub fn new<S: AsRef<str>>(global: Global<'base>, symbol: S) -> Self

Convert the given string to a Symbol.

pub fn extend<'global>(self, _: Global<'global>) -> Symbol<'global>

Extend the Symbol's lifetime. Symbols are not garbage collected, but a Symbol returned as a Value from a Julia function inherits the frame's lifetime when it's cast to a Symbol. Its lifetime can be safely extended from 'frame to 'global using this method.

pub fn hash(self) -> usize

The hash of this Symbol.

pub fn left(self) -> Option<Symbol<'base>>

Symbols are stored using an invasive binary tree, this returns the left branch of the current node.

pub fn right(self) -> Option<Symbol<'base>>

Symbols are stored using an invasive binary tree, this returns the right branch of the current node.

pub fn as_value(self) -> Value<'base, 'static>

Convert self to a Value.

pub fn as_string(self) -> String

Convert self to a String.

Trait Implementations

impl<'frame, 'data> Cast<'frame, 'data> for Symbol<'frame>

type Output = Self

fn cast(value: Value<'frame, 'data>) -> JlrsResult<Self::Output>

unsafe fn cast_unchecked(value: Value<'frame, 'data>) -> Self::Output

impl<'base> Clone for Symbol<'base>

fn clone(&self) -> Symbol<'base>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'base> Copy for Symbol<'base>

impl<'scope> Debug for Symbol<'scope>

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

Formats the value using the given formatter.

impl<'base, S> From<(Global<'base>, S)> for Symbol<'base> where
    S: AsRef<str>, 

fn from((_, symbol): (Global<'base>, S)) -> Self

Performs the conversion.

impl<'base> Into<String> for Symbol<'base>

fn into(self) -> String

Performs the conversion.

impl<'base> Into<Value<'base, 'static>> for Symbol<'base>

fn into(self) -> Value<'base, 'static>

Performs the conversion.

impl<'frame> JuliaType for Symbol<'frame>

unsafe fn julia_type() -> *mut jl_datatype_t

impl<'frame> JuliaTypecheck for Symbol<'frame>

unsafe fn julia_typecheck(t: DataType<'_>) -> bool

impl<'s> TemporarySymbol for Symbol<'s>

impl<'frame> ValidLayout for Symbol<'frame>

unsafe fn valid_layout(v: Value<'_, '_>) -> bool