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>

Methods from Deref<Target = Name>

pub fn get_identity_hash(&self) -> NonZeroI32

Returns the V8 hash value for this value. The current implementation uses a hidden property to store the identity hash.

The return value will never be 0. Also, it is not guaranteed to be unique.

Methods from Deref<Target = Value>

pub fn is_undefined(&self) -> bool

Returns true if this value is the undefined value. See ECMA-262 4.3.10.

pub fn is_null(&self) -> bool

Returns true if this value is the null value. See ECMA-262 4.3.11.

pub fn is_null_or_undefined(&self) -> bool

Returns true if this value is either the null or the undefined value. See ECMA-262 4.3.11. and 4.3.12

pub fn is_true(&self) -> bool

Returns true if this value is true. This is not the same as BooleanValue(). The latter performs a conversion to boolean, i.e. the result of Boolean(value) in JS, whereas this checks value === true.

pub fn is_false(&self) -> bool

Returns true if this value is false. This is not the same as !BooleanValue(). The latter performs a conversion to boolean, i.e. the result of !Boolean(value) in JS, whereas this checks value === false.

pub fn is_name(&self) -> bool

Returns true if this value is a symbol or a string. This is equivalent to typeof value === 'string' || typeof value === 'symbol' in JS.

pub fn is_string(&self) -> bool

Returns true if this value is an instance of the String type. See ECMA-262 8.4.

pub fn is_symbol(&self) -> bool

Returns true if this value is a symbol. This is equivalent to typeof value === 'symbol' in JS.

pub fn is_function(&self) -> bool

Returns true if this value is a function.

pub fn is_array(&self) -> bool

Returns true if this value is an array. Note that it will return false for an Proxy for an array.

pub fn is_object(&self) -> bool

Returns true if this value is an object.

pub fn is_big_int(&self) -> bool

Returns true if this value is a bigint. This is equivalent to typeof value === 'bigint' in JS.

pub fn is_boolean(&self) -> bool

Returns true if this value is boolean. This is equivalent to typeof value === 'boolean' in JS.

pub fn is_number(&self) -> bool

Returns true if this value is a number.

pub fn is_external(&self) -> bool

Returns true if this value is an External object.

pub fn is_int32(&self) -> bool

Returns true if this value is a 32-bit signed integer.

pub fn is_uint32(&self) -> bool

Returns true if this value is a 32-bit unsigned integer.

pub fn is_date(&self) -> bool

Returns true if this value is a Date.

pub fn is_arguments_object(&self) -> bool

Returns true if this value is an Arguments object.

pub fn is_big_int_object(&self) -> bool

Returns true if this value is a BigInt object.

pub fn is_boolean_object(&self) -> bool

Returns true if this value is a Boolean object.

pub fn is_number_object(&self) -> bool

Returns true if this value is a Number object.

pub fn is_string_object(&self) -> bool

Returns true if this value is a String object.

pub fn is_symbol_object(&self) -> bool

Returns true if this value is a Symbol object.

pub fn is_native_error(&self) -> bool

Returns true if this value is a NativeError.

pub fn is_reg_exp(&self) -> bool

Returns true if this value is a RegExp.

pub fn is_async_function(&self) -> bool

Returns true if this value is an async function.

pub fn is_generator_function(&self) -> bool

Returns true if this value is a Generator function.

pub fn is_promise(&self) -> bool

Returns true if this value is a Promise.

pub fn is_map(&self) -> bool

Returns true if this value is a Map.

pub fn is_set(&self) -> bool

Returns true if this value is a Set.

pub fn is_map_iterator(&self) -> bool

Returns true if this value is a Map Iterator.

pub fn is_set_iterator(&self) -> bool

Returns true if this value is a Set Iterator.

pub fn is_weak_map(&self) -> bool

Returns true if this value is a WeakMap.

pub fn is_weak_set(&self) -> bool

Returns true if this value is a WeakSet.

pub fn is_array_buffer(&self) -> bool

Returns true if this value is an ArrayBuffer.

pub fn is_array_buffer_view(&self) -> bool

Returns true if this value is an ArrayBufferView.

pub fn is_typed_array(&self) -> bool

Returns true if this value is one of TypedArrays.

pub fn is_uint8_array(&self) -> bool

Returns true if this value is an Uint8Array.

pub fn is_uint8_clamped_array(&self) -> bool

Returns true if this value is an Uint8ClampedArray.

pub fn is_int8_array(&self) -> bool

Returns true if this value is an Int8Array.

pub fn is_uint16_array(&self) -> bool

Returns true if this value is an Uint16Array.

pub fn is_int16_array(&self) -> bool

Returns true if this value is an Int16Array.

pub fn is_uint32_array(&self) -> bool

Returns true if this value is an Uint32Array.

pub fn is_int32_array(&self) -> bool

Returns true if this value is an Int32Array.

pub fn is_float32_array(&self) -> bool

Returns true if this value is a Float32Array.

pub fn is_float64_array(&self) -> bool

Returns true if this value is a Float64Array.

pub fn is_big_int64_array(&self) -> bool

Returns true if this value is a BigInt64Array.

pub fn is_big_uint64_array(&self) -> bool

Returns true if this value is a BigUint64Array.

pub fn is_data_view(&self) -> bool

Returns true if this value is a DataView.

pub fn is_shared_array_buffer(&self) -> bool

Returns true if this value is a SharedArrayBuffer. This is an experimental feature.

pub fn is_proxy(&self) -> bool

Returns true if this value is a JavaScript Proxy.

pub fn is_wasm_memory_object(&self) -> bool

Returns true if this value is a WasmMemoryObject.

pub fn is_wasm_module_object(&self) -> bool

Returns true if this value is a WasmModuleObject.

pub fn is_module_namespace_object(&self) -> bool

Returns true if the value is a Module Namespace Object.

pub fn strict_equals(&self, that: Local<'_, Value>) -> bool

pub fn same_value(&self, that: Local<'_, Value>) -> bool

pub fn same_value_zero(&self, that: Local<'_, Value>) -> bool

Implements the the abstract operation SameValueZero, which is defined in ECMA-262 6th edition § 7.2.10 (http://ecma-international.org/ecma-262/6.0/#sec-samevaluezero).

This operation is used to compare values for the purpose of insertion into a Set, or determining whether Map keys are equivalent. Its semantics are almost the same as strict_equals() and same_value(), with the following important distinctions:

• It considers NaN equal to NaN (unlike strict_equals()).
• It considers -0 equal to 0 (unlike same_value()).

pub fn to_big_int<'s>(
    &self,
    scope: &mut HandleScope<'s>
) -> Option<Local<'s, BigInt>>

pub fn to_number<'s>(
    &self,
    scope: &mut HandleScope<'s>
) -> Option<Local<'s, Number>>

pub fn to_string<'s>(
    &self,
    scope: &mut HandleScope<'s>
) -> Option<Local<'s, String>>

pub fn to_rust_string_lossy<'s>(&self, scope: &mut HandleScope<'s>) -> String

Convenience function not present in the original V8 API.

pub fn to_detail_string<'s>(
    &self,
    scope: &mut HandleScope<'s>
) -> Option<Local<'s, String>>

pub fn to_object<'s>(
    &self,
    scope: &mut HandleScope<'s>
) -> Option<Local<'s, Object>>

pub fn to_integer<'s>(
    &self,
    scope: &mut HandleScope<'s>
) -> Option<Local<'s, Integer>>

pub fn to_uint32<'s>(
    &self,
    scope: &mut HandleScope<'s>
) -> Option<Local<'s, Uint32>>

pub fn to_int32<'s>(
    &self,
    scope: &mut HandleScope<'s>
) -> Option<Local<'s, Int32>>

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

Perform the equivalent of Boolean(value) in JS. This can never fail.

pub fn instance_of<'s>(
    &self,
    scope: &mut HandleScope<'s>,
    object: Local<'_, Object>
) -> Option<bool>

pub fn number_value<'s>(&self, scope: &mut HandleScope<'s>) -> Option<f64>

pub fn integer_value<'s>(&self, scope: &mut HandleScope<'s>) -> Option<i64>

pub fn uint32_value<'s>(&self, scope: &mut HandleScope<'s>) -> Option<u32>

pub fn int32_value<'s>(&self, scope: &mut HandleScope<'s>) -> Option<i32>

pub fn boolean_value<'s>(&self, scope: &mut HandleScope<'s, ()>) -> bool

pub fn get_hash(&self) -> NonZeroI32

Returns the V8 hash value for this value. The current implementation uses a hidden property to store the identity hash on some object types.

The return value will never be 0. Also, it is not guaranteed to be unique.

Methods from Deref<Target = Data>

pub fn is_big_int(&self) -> bool

Returns true if this data is a BigInt.

pub fn is_boolean(&self) -> bool

Returns true if this data is a Boolean.

pub fn is_context(&self) -> bool

Returns true if this data is a Context.

pub fn is_fixed_array(&self) -> bool

Returns true if this data is a FixedArray.

pub fn is_function_template(&self) -> bool

Returns true if this data is a FunctionTemplate.

pub fn is_module(&self) -> bool

Returns true if this data is a Module.

pub fn is_module_request(&self) -> bool

Returns true if this data is a ModuleRequest.

pub fn is_name(&self) -> bool

Returns true if this data is a Name.

pub fn is_number(&self) -> bool

Returns true if this data is a Number.

pub fn is_object_template(&self) -> bool

Returns true if this data is a ObjectTemplate.

pub fn is_primitive(&self) -> bool

Returns true if this data is a Primitive.

pub fn is_private(&self) -> bool

Returns true if this data is a Private.

pub fn is_string(&self) -> bool

Returns true if this data is a String.

pub fn is_symbol(&self) -> bool

Returns true if this data is a Symbol.

pub fn is_value(&self) -> bool

Returns true if this data is a Value.

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,
    Self: Sized,

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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Symbol