Struct v8::Symbol

#[repr(C)]
pub struct Symbol(_);

A JavaScript symbol (ECMA-262 edition 6)

Implementations

impl Symbol

pub fn new<'s>(
    scope: &mut HandleScope<'s, ()>,
    description: Option<Local<'_, String>>
) -> Local<'s, Symbol>

Create a symbol. If description is not empty, it will be used as the description.

pub fn for_global<'s>(
    scope: &mut HandleScope<'s, ()>,
    description: Local<'_, String>
) -> Local<'s, Symbol>

Access global symbol registry. Note that symbols created this way are never collected, so they should only be used for statically fixed properties. Also, there is only one global description space for the descriptions used as keys. To minimize the potential for clashes, use qualified descriptions as keys. Corresponds to v8::Symbol::For() in C++.

pub fn description<'s>(
    &self,
    scope: &mut HandleScope<'s, ()>
) -> Local<'s, Value>

Returns the description string of the symbol, or undefined if none.

pub fn get_async_iterator<'s>(
    scope: &mut HandleScope<'s, ()>
) -> Local<'s, Symbol>

pub fn get_has_instance<'s>(
    scope: &mut HandleScope<'s, ()>
) -> Local<'s, Symbol>

pub fn get_is_concat_spreadable<'s>(
    scope: &mut HandleScope<'s, ()>
) -> Local<'s, Symbol>

pub fn get_iterator<'s>(scope: &mut HandleScope<'s, ()>) -> Local<'s, Symbol>

pub fn get_match<'s>(scope: &mut HandleScope<'s, ()>) -> Local<'s, Symbol>

pub fn get_replace<'s>(scope: &mut HandleScope<'s, ()>) -> Local<'s, Symbol>

pub fn get_search<'s>(scope: &mut HandleScope<'s, ()>) -> Local<'s, Symbol>

pub fn get_split<'s>(scope: &mut HandleScope<'s, ()>) -> Local<'s, Symbol>

pub fn get_to_primitive<'s>(
    scope: &mut HandleScope<'s, ()>
) -> Local<'s, Symbol>

pub fn get_to_string_tag<'s>(
    scope: &mut HandleScope<'s, ()>
) -> Local<'s, Symbol>

pub fn get_unscopables<'s>(scope: &mut HandleScope<'s, ()>) -> Local<'s, Symbol>

Trait Implementations

impl Debug for Symbol

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

Formats the value using the given formatter.

impl Deref for Symbol

type Target = Name

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for Symbol

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, 

Feeds a slice of this type into the given Hasher.

impl<'s> PartialEq<Data> for Symbol

fn eq(&self, other: &Data) -> 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 !=.

impl<'s> PartialEq<Name> for Symbol

fn eq(&self, other: &Name) -> 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 !=.

impl<'s> PartialEq<Primitive> for Symbol

fn eq(&self, other: &Primitive) -> 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 !=.

impl<'s> PartialEq<Symbol> for Data

fn eq(&self, other: &Symbol) -> 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 !=.

impl<'s> PartialEq<Symbol> for Value

fn eq(&self, other: &Symbol) -> 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 !=.

impl<'s> PartialEq<Symbol> for Primitive

fn eq(&self, other: &Symbol) -> 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 !=.

impl<'s> PartialEq<Symbol> for Name

fn eq(&self, other: &Symbol) -> 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 !=.

impl<'s> PartialEq<Symbol> for Symbol

fn eq(&self, other: &Symbol) -> 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 !=.

impl<'s> PartialEq<Value> for Symbol

fn eq(&self, other: &Value) -> 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 !=.

impl Eq for Symbol