Struct Symbol

pub struct Symbol { /* private fields */ }

Available on crate feature dep_web_sys only.

Implementations

impl Symbol

pub fn has_instance() -> Symbol

Available on crate feature dep_js_sys only.

The Symbol.hasInstance well-known symbol is used to determine if a constructor object recognizes an object as its instance. The instanceof operator’s behavior can be customized by this symbol.

MDN documentation

impl Symbol

pub fn is_concat_spreadable() -> Symbol

Available on crate feature dep_js_sys only.

The Symbol.isConcatSpreadable well-known symbol is used to configure if an object should be flattened to its array elements when using the Array.prototype.concat() method.

MDN documentation

impl Symbol

pub fn async_iterator() -> Symbol

Available on crate feature dep_js_sys only.

The Symbol.asyncIterator well-known symbol specifies the default AsyncIterator for an object. If this property is set on an object, it is an async iterable and can be used in a for await...of loop.

MDN documentation

impl Symbol

pub fn iterator() -> Symbol

Available on crate feature dep_js_sys only.

The Symbol.iterator well-known symbol specifies the default iterator for an object. Used by for...of.

MDN documentation

impl Symbol

pub fn match_() -> Symbol

Available on crate feature dep_js_sys only.

The Symbol.match well-known symbol specifies the matching of a regular expression against a string. This function is called by the String.prototype.match() method.

MDN documentation

impl Symbol

pub fn replace() -> Symbol

Available on crate feature dep_js_sys only.

The Symbol.replace well-known symbol specifies the method that replaces matched substrings of a string. This function is called by the String.prototype.replace() method.

For more information, see RegExp.prototype[@@replace]() and String.prototype.replace().

MDN documentation

impl Symbol

pub fn search() -> Symbol

Available on crate feature dep_js_sys only.

The Symbol.search well-known symbol specifies the method that returns the index within a string that matches the regular expression. This function is called by the String.prototype.search() method.

For more information, see RegExp.prototype[@@search]() and String.prototype.search().

MDN documentation

impl Symbol

pub fn species() -> Symbol

Available on crate feature dep_js_sys only.

The well-known symbol Symbol.species specifies a function-valued property that the constructor function uses to create derived objects.

MDN documentation

impl Symbol

pub fn split() -> Symbol

Available on crate feature dep_js_sys only.

The Symbol.split well-known symbol specifies the method that splits a string at the indices that match a regular expression. This function is called by the String.prototype.split() method.

For more information, see RegExp.prototype[@@split]() and String.prototype.split(). MDN documentation

impl Symbol

pub fn to_primitive() -> Symbol

Available on crate feature dep_js_sys only.

The Symbol.toPrimitive is a symbol that specifies a function valued property that is called to convert an object to a corresponding primitive value.

MDN documentation

impl Symbol

pub fn to_string_tag() -> Symbol

Available on crate feature dep_js_sys only.

The Symbol.toStringTag well-known symbol is a string valued property that is used in the creation of the default string description of an object. It is accessed internally by the Object.prototype.toString() method.

MDN documentation

impl Symbol

pub fn for_(key: &str) -> Symbol

Available on crate feature dep_js_sys only.

The Symbol.for(key) method searches for existing symbols in a runtime-wide symbol registry with the given key and returns it if found. Otherwise a new symbol gets created in the global symbol registry with this key.

MDN documentation

impl Symbol

pub fn key_for(sym: &Symbol) -> JsValue

Available on crate feature dep_js_sys only.

The Symbol.keyFor(sym) method retrieves a shared symbol key from the global symbol registry for the given symbol.

MDN documentation

impl Symbol

pub fn to_string(&self) -> JsString

Available on crate feature dep_js_sys only.

The toString() method returns a string representing the specified Symbol object.

MDN documentation

impl Symbol

pub fn unscopables() -> Symbol

Available on crate feature dep_js_sys only.

The Symbol.unscopables well-known symbol is used to specify an object value of whose own and inherited property names are excluded from the with environment bindings of the associated object.

MDN documentation

impl Symbol

pub fn value_of(&self) -> Symbol

Available on crate feature dep_js_sys only.

The valueOf() method returns the primitive value of a Symbol object.

MDN documentation

Methods from Deref<Target = JsValue>

pub const NULL: JsValue

pub const UNDEFINED: JsValue

pub const TRUE: JsValue

pub const FALSE: JsValue

pub fn as_f64(&self) -> Option<f64>

Available on crate feature dep_js_sys only.

Returns the f64 value of this JS value if it’s an instance of a number.

If this JS value is not an instance of a number then this returns None.

pub fn is_string(&self) -> bool

Available on crate feature dep_js_sys only.

Tests whether this JS value is a JS string.

pub fn as_string(&self) -> Option<String>

Available on crate feature dep_js_sys only.

If this JS value is a string value, this function copies the JS string value into Wasm linear memory, encoded as UTF-8, and returns it as a Rust String.

To avoid the copying and re-encoding, consider the JsString::try_from() function from js-sys instead.

If this JS value is not an instance of a string or if it’s not valid utf-8 then this returns None.

UTF-16 vs UTF-8

JavaScript strings in general are encoded as UTF-16, but Rust strings are encoded as UTF-8. This can cause the Rust string to look a bit different than the JS string sometimes. For more details see the documentation about the str type which contains a few caveats about the encodings.

pub fn as_bool(&self) -> Option<bool>

Available on crate feature dep_js_sys only.

Returns the bool value of this JS value if it’s an instance of a boolean.

If this JS value is not an instance of a boolean then this returns None.

pub fn is_null(&self) -> bool

Available on crate feature dep_js_sys only.

Tests whether this JS value is null

pub fn is_undefined(&self) -> bool

Available on crate feature dep_js_sys only.

Tests whether this JS value is undefined

pub fn is_symbol(&self) -> bool

Available on crate feature dep_js_sys only.

Tests whether the type of this JS value is symbol

pub fn is_object(&self) -> bool

Available on crate feature dep_js_sys only.

Tests whether typeof self == "object" && self !== null.

pub fn is_array(&self) -> bool

Available on crate feature dep_js_sys only.

Tests whether this JS value is an instance of Array.

pub fn is_function(&self) -> bool

Available on crate feature dep_js_sys only.

Tests whether the type of this JS value is function.

pub fn is_bigint(&self) -> bool

Available on crate feature dep_js_sys only.

Tests whether the type of this JS value is bigint.

pub fn js_typeof(&self) -> JsValue

Available on crate feature dep_js_sys only.

Applies the unary typeof JS operator on a JsValue.

MDN documentation

pub fn js_in(&self, obj: &JsValue) -> bool

Available on crate feature dep_js_sys only.

Applies the binary in JS operator on the two JsValues.

MDN documentation

pub fn is_truthy(&self) -> bool

Available on crate feature dep_js_sys only.

Tests whether the value is “truthy”.

pub fn is_falsy(&self) -> bool

Available on crate feature dep_js_sys only.

Tests whether the value is “falsy”.

pub fn loose_eq(&self, other: &JsValue) -> bool

Available on crate feature dep_js_sys only.

Compare two JsValues for equality, using the == operator in JS.

MDN documentation

pub fn bit_not(&self) -> JsValue

Available on crate feature dep_js_sys only.

Applies the unary ~ JS operator on a JsValue.

MDN documentation

pub fn unsigned_shr(&self, rhs: &JsValue) -> u32

Available on crate feature dep_js_sys only.

Applies the binary >>> JS operator on the two JsValues.

MDN documentation

pub fn checked_div(&self, rhs: &JsValue) -> JsValue

Available on crate feature dep_js_sys only.

Applies the binary / JS operator on two JsValues, catching and returning any RangeError thrown.

MDN documentation

pub fn pow(&self, rhs: &JsValue) -> JsValue

Available on crate feature dep_js_sys only.

Applies the binary ** JS operator on the two JsValues.

MDN documentation

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

Available on crate feature dep_js_sys only.

Applies the binary < JS operator on the two JsValues.

MDN documentation

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

Available on crate feature dep_js_sys only.

Applies the binary <= JS operator on the two JsValues.

MDN documentation

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

Available on crate feature dep_js_sys only.

Applies the binary >= JS operator on the two JsValues.

MDN documentation

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

Available on crate feature dep_js_sys only.

Applies the binary > JS operator on the two JsValues.

MDN documentation

pub fn unchecked_into_f64(&self) -> f64

Available on crate feature dep_js_sys only.

Applies the unary + JS operator on a JsValue. Can throw.

MDN documentation

Trait Implementations

impl AsRef<JsValue> for Symbol

fn as_ref(&self) -> &JsValue

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Symbol> for Symbol

fn as_ref(&self) -> &Symbol

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Symbol

fn clone(&self) -> Symbol

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<(), Error>

Formats the value using the given formatter.

impl Deref for Symbol

type Target = JsValue

The resulting type after dereferencing.

fn deref(&self) -> &JsValue

Dereferences the value.

impl From<JsValue> for Symbol

fn from(obj: JsValue) -> Symbol

Converts to this type from the input type.

impl From<Symbol> for JsValue

fn from(obj: Symbol) -> JsValue

Converts to this type from the input type.

impl FromWasmAbi for Symbol

type Abi = <JsValue as FromWasmAbi>::Abi

The Wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: <Symbol as FromWasmAbi>::Abi) -> Symbol

Recover a Self from Self::Abi.

impl<'a> IntoWasmAbi for &'a Symbol

type Abi = <&'a JsValue as IntoWasmAbi>::Abi

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> <&'a Symbol as IntoWasmAbi>::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl IntoWasmAbi for Symbol

type Abi = <JsValue as IntoWasmAbi>::Abi

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> <Symbol as IntoWasmAbi>::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl JsCast for Symbol

fn instanceof(val: &JsValue) -> bool

Performs a dynamic instanceof check to see whether the JsValue provided is an instance of this type.

fn is_type_of(val: &JsValue) -> bool

Performs a dynamic check to see whether the JsValue provided is a value of this type.

fn unchecked_from_js(val: JsValue) -> Symbol

Performs a zero-cost unchecked conversion from a JsValue into an instance of Self

fn unchecked_from_js_ref(val: &JsValue) -> &Symbol

Performs a zero-cost unchecked conversion from a &JsValue into an instance of &Self.

fn has_type<T>(&self) -> bool

where T: JsCast,

Test whether this JS value has a type T.

fn dyn_into<T>(self) -> Result<T, Self>

where T: JsCast,

Performs a dynamic cast (checked at runtime) of this value into the target type T.

fn dyn_ref<T>(&self) -> Option<&T>

where T: JsCast,

Performs a dynamic cast (checked at runtime) of this value into the target type T.

fn unchecked_into<T>(self) -> T

where T: JsCast,

Performs a zero-cost unchecked cast into the specified type.

fn unchecked_ref<T>(&self) -> &T

where T: JsCast,

Performs a zero-cost unchecked cast into a reference to the specified type.

fn is_instance_of<T>(&self) -> bool

where T: JsCast,

Test whether this JS value is an instance of the type T.

impl LongRefFromWasmAbi for Symbol

type Abi = <JsValue as LongRefFromWasmAbi>::Abi

Same as RefFromWasmAbi::Abi

type Anchor = Symbol

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi( js: <Symbol as LongRefFromWasmAbi>::Abi, ) -> <Symbol as LongRefFromWasmAbi>::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for Symbol

fn is_none(abi: &<Symbol as FromWasmAbi>::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl<'a> OptionIntoWasmAbi for &'a Symbol

fn none() -> <&'a Symbol as IntoWasmAbi>::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl OptionIntoWasmAbi for Symbol

fn none() -> <Symbol as IntoWasmAbi>::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for Symbol

type Abi = <JsValue as RefFromWasmAbi>::Abi

The Wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<Symbol>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi( js: <Symbol as RefFromWasmAbi>::Abi, ) -> <Symbol as RefFromWasmAbi>::Anchor

Recover a Self::Anchor from Self::Abi.