Struct jlrs::wrappers::ptr::symbol::Symbol

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

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. They’re also used as the building-block of expressions.

One special property of Symbols is that they’re never freed by the garbage collector after they’ve been created.

Implementations

impl<'scope> Symbol<'scope>

pub fn new<S: AsRef<str>>(_: Global<'scope>, 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 never freed by the garbage collector, 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 'scope to 'global using this method.

pub fn hash(self) -> usize

The hash of this Symbol.

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

Symbols are stored using an invasive binary tree, this returns the left branch of the current node. This method is unsafe because it’s not accessible from Julia except through the C API.

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

Symbols are stored using an invasive binary tree, this returns the right branch of the current node. This method is unsafe because it’s not accessible from Julia except through the C API.

pub fn as_leaked(self) -> LeakedValue

Convert self to a LeakedValue.

pub fn as_string(self) -> JlrsResult<String>

Convert self to a String.

pub fn as_str(self) -> JlrsResult<&'scope str>

View self as a string slice. Returns an error if the symbol is not valid UTF8.

pub fn as_cstr(self) -> &'scope CStr

View self as a Cstr.

pub fn as_slice(self) -> &'scope [u8]

View self as an slice of bytes without the trailing null.

Trait Implementations

impl<'scope> Clone for Symbol<'scope>

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

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<'scope> ValidLayout for Symbol<'scope>

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

Check if the layout of the implementor is compatible with the layout of ty. This argument is a Value to account for the fact that a field type can be a Union, UnionAll or Union{}.

impl<'scope> Copy for Symbol<'scope>

impl TemporarySymbol for Symbol<'_>

impl<'scope> Typecheck for Symbol<'scope>