Struct Symbol 

pub struct Symbol<'s> {
    sym: Local<'s, *mut Symbol>,
}

Represents a symbol in the JavaScript Runtime. Refer to MDN for more details.

Fields

sym: Local<'s, *mut Symbol>

Implementations

impl Symbol<'_>

pub fn new<'cx>(cx: &'cx Context, description: &str) -> Symbol<'cx>

Creates a new unique symbol with a given description.

pub fn for_key<'cx>(cx: &'cx Context, key: &str) -> Symbol<'cx>

Gets a Symbol from the symbol registry with the given key.

pub fn well_known(cx: &Context, code: WellKnownSymbolCode) -> Symbol<'_>

Creates a well-known symbol with its corresponding code.

pub fn code(&self) -> SymbolCode

Returns the identifying code of a Symbol.

pub fn description(&self, cx: &Context) -> Option<String>

Returns the description of a Symbol. Returns None for well-known symbols.

Methods from Deref<Target = Local<'s, *mut JSSymbol>>

pub fn handle(&self) -> Handle<'local, T>

Forms a Handle to the Local which can be passed to SpiderMonkey APIs.

pub fn handle_mut(&mut self) -> MutableHandle<'local, T>

Forms a Handle to the Local which can be passed to SpiderMonkey APIs.

Panics

Panics when a Local::Handle is passed.

pub fn get(&self) -> T

Trait Implementations

impl<'s> Debug for Symbol<'s>

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

Formats the value using the given formatter.

impl<'s> Deref for Symbol<'s>

type Target = Local<'s, *mut Symbol>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Symbol<'_>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'o> From<Local<'o, *mut Symbol>> for Symbol<'o>

fn from(sym: Local<'o, *mut JSSymbol>) -> Symbol<'o>

Converts to this type from the input type.

impl<'cx> FromValue<'cx> for Symbol<'cx>

type Config = ()

fn from_value( cx: &'cx Context, value: &Value<'_>, strict: bool, config: Self::Config, ) -> Result<Symbol<'cx>>

Converts value to the desired type. strict and config determine the strictness of the conversion and specify additional conversion constraints respectively. Returns Err with the error if conversion fails.

impl<'cx> ToPropertyKey<'cx> for Symbol<'_>

fn to_key(&self, cx: &'cx Context) -> Option<PropertyKey<'cx>>

Converts self to a new PropertyKey. Returns None when conversion fails.

impl<'cx> ToValue<'cx> for Symbol<'cx>

fn to_value(&self, cx: &'cx Context, value: &mut Value<'_>)

Converts self to a Value and stores it in value.

fn as_value(&self, cx: &'cx Context) -> Value<'cx>

Converts self to a new Value.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 16 bytes