Struct js_sys::Symbol [−][src]
#[repr(transparent)]pub struct Symbol { /* fields omitted */ }
Implementations
impl Symbol
[src]
impl Symbol
[src]pub fn has_instance() -> Symbol
[src]
pub fn has_instance() -> Symbol
[src]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.
impl Symbol
[src]
impl Symbol
[src]pub fn is_concat_spreadable() -> Symbol
[src]
pub fn is_concat_spreadable() -> Symbol
[src]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.
impl Symbol
[src]
impl Symbol
[src]pub fn async_iterator() -> Symbol
[src]
pub fn async_iterator() -> Symbol
[src]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.
impl Symbol
[src]
impl Symbol
[src]impl Symbol
[src]
impl Symbol
[src]impl Symbol
[src]
impl Symbol
[src]impl Symbol
[src]
impl Symbol
[src]pub fn search() -> Symbol
[src]
pub fn search() -> Symbol
[src]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()
.
impl Symbol
[src]
impl Symbol
[src]impl Symbol
[src]
impl Symbol
[src]pub fn split() -> Symbol
[src]
pub fn split() -> Symbol
[src]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
[src]
impl Symbol
[src]pub fn to_primitive() -> Symbol
[src]
pub fn to_primitive() -> Symbol
[src]The Symbol.toPrimitive
is a symbol that specifies a function valued
property that is called to convert an object to a corresponding
primitive value.
impl Symbol
[src]
impl Symbol
[src]pub fn to_string_tag() -> Symbol
[src]
pub fn to_string_tag() -> Symbol
[src]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.
impl Symbol
[src]
impl Symbol
[src]impl Symbol
[src]
impl Symbol
[src]impl Symbol
[src]
impl Symbol
[src]impl Symbol
[src]
impl Symbol
[src]pub fn unscopables() -> Symbol
[src]
pub fn unscopables() -> Symbol
[src]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.
impl Symbol
[src]
impl Symbol
[src]Methods from Deref<Target = JsValue>
pub const NULL: JsValue
[src]
pub const UNDEFINED: JsValue
[src]
pub const TRUE: JsValue
[src]
pub const FALSE: JsValue
[src]
pub fn as_f64(&self) -> Option<f64>
[src]
pub fn as_f64(&self) -> Option<f64>
[src]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 as_string(&self) -> Option<String>
[src]
pub fn as_string(&self) -> Option<String>
[src]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>
[src]
pub fn as_bool(&self) -> Option<bool>
[src]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_undefined(&self) -> bool
[src]
pub fn is_undefined(&self) -> bool
[src]Tests whether this JS value is undefined
pub fn is_function(&self) -> bool
[src]
pub fn is_function(&self) -> bool
[src]Tests whether the type of this JS value is function
.
Trait Implementations
impl FromWasmAbi for Symbol
[src]
impl FromWasmAbi for Symbol
[src]impl IntoWasmAbi for Symbol
[src]
impl IntoWasmAbi for Symbol
[src]impl<'a> IntoWasmAbi for &'a Symbol
[src]
impl<'a> IntoWasmAbi for &'a Symbol
[src]impl JsCast for Symbol
[src]
impl JsCast for Symbol
[src]fn instanceof(val: &JsValue) -> bool
[src]
fn instanceof(val: &JsValue) -> bool
[src]Performs a dynamic instanceof
check to see whether the JsValue
provided is an instance of this type. Read more
fn is_type_of(val: &JsValue) -> bool
[src]
fn is_type_of(val: &JsValue) -> bool
[src]Performs a dynamic check to see whether the JsValue
provided
is a value of this type. Read more
fn unchecked_from_js(val: JsValue) -> Self
[src]
fn unchecked_from_js(val: JsValue) -> Self
[src]Performs a zero-cost unchecked conversion from a JsValue
into an
instance of Self
Read more
fn unchecked_from_js_ref(val: &JsValue) -> &Self
[src]
fn unchecked_from_js_ref(val: &JsValue) -> &Self
[src]Performs a zero-cost unchecked conversion from a &JsValue
into an
instance of &Self
. Read more
fn has_type<T>(&self) -> bool where
T: JsCast,
[src]
fn has_type<T>(&self) -> bool where
T: JsCast,
[src]Test whether this JS value has a type T
. Read more
fn dyn_into<T>(self) -> Result<T, Self> where
T: JsCast,
[src]
fn dyn_into<T>(self) -> Result<T, Self> where
T: JsCast,
[src]Performs a dynamic cast (checked at runtime) of this value into the
target type T
. Read more
fn dyn_ref<T>(&self) -> Option<&T> where
T: JsCast,
[src]
fn dyn_ref<T>(&self) -> Option<&T> where
T: JsCast,
[src]Performs a dynamic cast (checked at runtime) of this value into the
target type T
. Read more
fn unchecked_into<T>(self) -> T where
T: JsCast,
[src]
fn unchecked_into<T>(self) -> T where
T: JsCast,
[src]Performs a zero-cost unchecked cast into the specified type. Read more
fn unchecked_ref<T>(&self) -> &T where
T: JsCast,
[src]
fn unchecked_ref<T>(&self) -> &T where
T: JsCast,
[src]Performs a zero-cost unchecked cast into a reference to the specified type. Read more
fn is_instance_of<T>(&self) -> bool where
T: JsCast,
[src]
fn is_instance_of<T>(&self) -> bool where
T: JsCast,
[src]Test whether this JS value is an instance of the type T
. Read more
impl OptionFromWasmAbi for Symbol
[src]
impl OptionFromWasmAbi for Symbol
[src]impl OptionIntoWasmAbi for Symbol
[src]
impl OptionIntoWasmAbi for Symbol
[src]impl<'a> OptionIntoWasmAbi for &'a Symbol
[src]
impl<'a> OptionIntoWasmAbi for &'a Symbol
[src]impl RefFromWasmAbi for Symbol
[src]
impl RefFromWasmAbi for Symbol
[src]type Abi = <JsValue as RefFromWasmAbi>::Abi
type Abi = <JsValue as RefFromWasmAbi>::Abi
The wasm ABI type references to Self
are recovered from.
type Anchor = ManuallyDrop<Symbol>
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. Read more
unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor
[src]
unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor
[src]Recover a Self::Anchor
from Self::Abi
. Read more
Auto Trait Implementations
impl RefUnwindSafe for Symbol
impl !Send for Symbol
impl !Sync for Symbol
impl Unpin for Symbol
impl UnwindSafe for Symbol
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> ReturnWasmAbi for T where
T: IntoWasmAbi,
[src]
impl<T> ReturnWasmAbi for T where
T: IntoWasmAbi,
[src]type Abi = <T as IntoWasmAbi>::Abi
type Abi = <T as IntoWasmAbi>::Abi
Same as IntoWasmAbi::Abi
pub fn return_abi(self) -> <T as ReturnWasmAbi>::Abi
[src]
pub fn return_abi(self) -> <T as ReturnWasmAbi>::Abi
[src]Same as IntoWasmAbi::into_abi
, except that it may throw and never
return in the case of Err
. Read more
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more