Struct JsObject 

pub struct JsObject(/* private fields */);

Available on crate features js and std only.

An immutable, insertion-ordered snapshot of a js object.

Keys are unique: constructing one from entries with duplicate keys collapses them like a js object literal (first position, last value).

The backing storage is shared, making clones O(1), and all conversions out of it are pull-based: nothing beyond the initial boundary snapshot is computed unless you ask for it. The concrete representation is private so it can evolve (e.g. become lazier) without breaking changes.

Implementations

impl JsObject

pub fn deserialize_into<T>(&self) -> Result<T, JsError>

where T: DeserializeOwned,

Deserialize this object into any serde-capable type.

impl JsObject

pub fn len(&self) -> usize

The number of properties in this object.

pub fn is_empty(&self) -> bool

Returns true if this object has no properties.

pub fn get(&self, key: impl AsRef<str>) -> Option<&JsValue>

The value of the property with the given key, if any.

pub fn contains_key(&self, key: impl AsRef<str>) -> bool

Returns true if this object has a property with the given key.

pub fn keys(&self) -> impl Iterator<Item = &JsStr>

Iterate over the property keys of this object, in insertion order.

pub fn values(&self) -> impl Iterator<Item = &JsValue>

Iterate over the property values of this object, in insertion order.

pub fn iter(&self) -> impl Iterator<Item = (&JsStr, &JsValue)>

Iterate over the properties of this object, in insertion order.

Trait Implementations

impl Clone for JsObject

fn clone(&self) -> JsObject

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JsObject

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

Formats the value using the given formatter.

impl Default for JsObject

fn default() -> JsObject

Returns the “default value” for a type.

impl Drop for JsObject

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl From<JsObject> for JsValue

fn from(obj: JsObject) -> JsValue

Converts to this type from the input type.

impl<K, V> From<Vec<(K, V)>> for JsObject

where K: Into<JsStr>, V: Into<JsValue>,

fn from(entries: Vec<(K, V)>) -> JsObject

Converts to this type from the input type.

impl<K, V> FromIterator<(K, V)> for JsObject

where K: Into<JsStr>, V: Into<JsValue>,

fn from_iter<I>(iter: I) -> JsObject

where I: IntoIterator<Item = (K, V)>,

Duplicate keys collapse like a js object literal: the first occurrence keeps its position, the last value wins.

impl<'a> IntoIterator for &'a JsObject

type Item = (&'a JsStr, &'a JsValue)

The type of the elements being iterated over.

type IntoIter = Map<Iter<'a, (JsStr, JsValue)>, fn(&'a (JsStr, JsValue)) -> (&'a JsStr, &'a JsValue)>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a JsObject as IntoIterator>::IntoIter

Creates an iterator from a value.

impl JsArg for JsObject

fn from_js(value: JsValue) -> Result<JsObject, JsError>

Extract this argument from the given value.

fn from_missing_js_arg() -> Result<Self, JsError>

Extract this argument when the caller did not provide it.

impl PartialEq for JsObject

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for JsObject

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for JsObject

impl TryFrom<JsValue> for JsObject

type Error = JsError

The type returned in the event of a conversion error.

fn try_from( value: JsValue, ) -> Result<JsObject, <JsObject as TryFrom<JsValue>>::Error>

Performs the conversion.