Struct js_sys::Map[][src]

#[repr(transparent)]pub struct Map { /* fields omitted */ }

Implementations

impl Map[src]

pub fn clear(&self)[src]

The clear() method removes all elements from a Map object.

MDN documentation

impl Map[src]

pub fn delete(&self, key: &JsValue) -> bool[src]

The delete() method removes the specified element from a Map object.

MDN documentation

impl Map[src]

pub fn for_each(&self, callback: &mut dyn FnMut(JsValue, JsValue))[src]

The forEach() method executes a provided function once per each key/value pair in the Map object, in insertion order. Note that in Javascript land the Key and Value are reversed compared to normal expectations:

Examples

let js_map = Map::new();
js_map.for_each(&mut |value, key| {
    // Do something here...
})

MDN documentation

impl Map[src]

pub fn get(&self, key: &JsValue) -> JsValue[src]

The get() method returns a specified element from a Map object.

MDN documentation

impl Map[src]

pub fn has(&self, key: &JsValue) -> bool[src]

The has() method returns a boolean indicating whether an element with the specified key exists or not.

MDN documentation

impl Map[src]

pub fn new() -> Map[src]

The Map object holds key-value pairs. Any value (both objects and primitive values) maybe used as either a key or a value.

MDN documentation

impl Map[src]

pub fn set(&self, key: &JsValue, value: &JsValue) -> Map[src]

The set() method adds or updates an element with a specified key and value to a Map object.

MDN documentation

impl Map[src]

pub fn size(&self) -> u32[src]

The value of size is an integer representing how many entries the Map object has. A set accessor function for size is undefined; you can not change this property.

MDN documentation

impl Map[src]

pub fn entries(&self) -> Iterator[src]

The entries() method returns a new Iterator object that contains the [key, value] pairs for each element in the Map object in insertion order.

MDN documentation

impl Map[src]

pub fn keys(&self) -> Iterator[src]

The keys() method returns a new Iterator object that contains the keys for each element in the Map object in insertion order.

MDN documentation

impl Map[src]

pub fn values(&self) -> Iterator[src]

The values() method returns a new Iterator object that contains the values for each element in the Map object in insertion order.

MDN documentation

Methods from Deref<Target = Object>

pub fn constructor(&self) -> Function[src]

The constructor property returns a reference to the Object constructor function that created the instance object.

MDN documentation

pub fn has_own_property(&self, property: &JsValue) -> bool[src]

The hasOwnProperty() method returns a boolean indicating whether the object has the specified property as its own property (as opposed to inheriting it).

MDN documentation

pub fn is_prototype_of(&self, value: &JsValue) -> bool[src]

The isPrototypeOf() method checks if an object exists in another object’s prototype chain.

MDN documentation

pub fn property_is_enumerable(&self, property: &JsValue) -> bool[src]

The propertyIsEnumerable() method returns a Boolean indicating whether the specified property is enumerable.

MDN documentation

pub fn to_locale_string(&self) -> JsString[src]

The toLocaleString() method returns a string representing the object. This method is meant to be overridden by derived objects for locale-specific purposes.

MDN documentation

pub fn to_string(&self) -> JsString[src]

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

MDN documentation

pub fn value_of(&self) -> Object[src]

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

MDN documentation

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]

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[src]

Tests whether this JS value is a JS string.

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]

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[src]

Tests whether this JS value is null

pub fn is_undefined(&self) -> bool[src]

Tests whether this JS value is undefined

pub fn is_symbol(&self) -> bool[src]

Tests whether the type of this JS value is symbol

pub fn is_object(&self) -> bool[src]

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

pub fn is_function(&self) -> bool[src]

Tests whether the type of this JS value is function.

pub fn is_truthy(&self) -> bool[src]

Tests whether the value is “truthy”.

pub fn is_falsy(&self) -> bool[src]

Tests whether the value is “falsy”.

Trait Implementations

impl AsRef<JsValue> for Map[src]

impl AsRef<Map> for Map[src]

impl AsRef<Object> for Map[src]

impl Clone for Map[src]

impl Debug for Map[src]

impl Deref for Map[src]

type Target = Object

The resulting type after dereferencing.

impl Eq for Map[src]

impl From<JsValue> for Map[src]

impl From<Map> for JsValue[src]

impl From<Map> for Object[src]

impl FromWasmAbi for Map[src]

type Abi = <JsValue as FromWasmAbi>::Abi

The wasm ABI type that this converts from when coming back out from the ABI boundary. Read more

impl IntoWasmAbi for Map[src]

type Abi = <JsValue as IntoWasmAbi>::Abi

The wasm ABI type that this converts into when crossing the ABI boundary. Read more

impl<'a> IntoWasmAbi for &'a Map[src]

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

The wasm ABI type that this converts into when crossing the ABI boundary. Read more

impl JsCast for Map[src]

impl OptionFromWasmAbi for Map[src]

impl OptionIntoWasmAbi for Map[src]

impl<'a> OptionIntoWasmAbi for &'a Map[src]

impl PartialEq<Map> for Map[src]

impl RefFromWasmAbi for Map[src]

type Abi = <JsValue as RefFromWasmAbi>::Abi

The wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<Map>

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

impl StructuralEq for Map[src]

impl StructuralPartialEq for Map[src]

impl WasmDescribe for Map[src]

Auto Trait Implementations

impl RefUnwindSafe for Map

impl !Send for Map

impl !Sync for Map

impl Unpin for Map

impl UnwindSafe for Map

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> ReturnWasmAbi for T where
    T: IntoWasmAbi
[src]

type Abi = <T as IntoWasmAbi>::Abi

Same as IntoWasmAbi::Abi

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.