Struct JsSymbol 

pub struct JsSymbol { /* private fields */ }

This represents a JavaScript symbol primitive.

Implementations

impl JsSymbol

pub fn new(description: Option<JsString>) -> Option<JsSymbol>

Creates a new symbol.

Returns None if the maximum number of possible symbols has been reached (u64::MAX).

pub fn description(&self) -> Option<JsString>

Returns the Symbol description.

pub fn fn_name(&self) -> JsString

Returns the Symbol as a function name.

Equivalent to [description], but returns the empty string if the symbol doesn’t have a description.

pub fn hash(&self) -> u64

Returns the Symbols hash.

The hash is guaranteed to be unique.

pub fn descriptive_string(&self) -> JsString

Abstract operation SymbolDescriptiveString ( sym )

More info:

• ECMAScript reference

pub const fn async_iterator() -> JsSymbol

Gets the static JsSymbol for "Symbol.asyncIterator".

pub const fn has_instance() -> JsSymbol

Gets the static JsSymbol for "Symbol.hasInstance".

pub const fn is_concat_spreadable() -> JsSymbol

Gets the static JsSymbol for "Symbol.isConcatSpreadable".

pub const fn iterator() -> JsSymbol

Gets the static JsSymbol for "Symbol.iterator".

pub const fn match() -> JsSymbol

Gets the static JsSymbol for "Symbol.match".

pub const fn match_all() -> JsSymbol

Gets the static JsSymbol for "Symbol.matchAll".

pub const fn replace() -> JsSymbol

Gets the static JsSymbol for "Symbol.replace".

pub const fn search() -> JsSymbol

Gets the static JsSymbol for "Symbol.search".

pub const fn species() -> JsSymbol

Gets the static JsSymbol for "Symbol.species".

pub const fn split() -> JsSymbol

Gets the static JsSymbol for "Symbol.split".

pub const fn to_primitive() -> JsSymbol

Gets the static JsSymbol for "Symbol.toPrimitive".

pub const fn to_string_tag() -> JsSymbol

Gets the static JsSymbol for "Symbol.toStringTag".

pub const fn unscopables() -> JsSymbol

Gets the static JsSymbol for "Symbol.unscopables".

Trait Implementations

impl Clone for JsSymbol

fn clone(&self) -> JsSymbol

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JsSymbol

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

Formats the value using the given formatter.

impl Display for JsSymbol

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

Formats the value using the given formatter.

impl Drop for JsSymbol

fn drop(&mut self)

Executes the destructor for this type.

impl Finalize for JsSymbol

fn finalize(&self)

Cleanup logic for a type.

impl From<JsSymbol> for FunctionBinding

fn from(binding: JsSymbol) -> FunctionBinding

Converts to this type from the input type.

impl From<JsSymbol> for JsValue

fn from(value: JsSymbol) -> JsValue

Converts to this type from the input type.

impl From<JsSymbol> for PropertyKey

fn from(symbol: JsSymbol) -> PropertyKey

Converts to this type from the input type.

impl Hash for JsSymbol

fn hash<H>(&self, state: &mut H)

where H: Hasher,

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 Ord for JsSymbol

fn cmp(&self, other: &JsSymbol) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for JsSymbol

fn eq(&self, other: &JsSymbol) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for JsSymbol

fn partial_cmp(&self, other: &JsSymbol) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Trace for JsSymbol

unsafe fn trace(&self, _tracer: &mut Tracer)

Marks all contained Gcs.

unsafe fn trace_non_roots(&self)

Trace handles located in GC heap, and mark them as non root.

fn run_finalizer(&self)

Runs Finalize::finalize on this object and all contained subobjects.

impl TryIntoJs for JsSymbol

fn try_into_js(&self, _context: &mut Context) -> Result<JsValue, JsError>

This function tries to convert a Self into JsValue.

impl Eq for JsSymbol

impl JsData for JsSymbol

impl Send for JsSymbol

impl Sync for JsSymbol