Struct brioche_ducc::Object

pub struct Object<'ducc>(_);

Reference to a JavaScript object (guaranteed to not be an array or function).

Methods

impl<'ducc> Object<'ducc>

pub fn get<K: ToValue<'ducc>, V: FromValue<'ducc>>(&self, key: K) -> Result<V>

Get an object property value using the given key. Returns Value::Undefined if no property with the key exists.

Errors

This function returns an error if:

• ToValue::to_value fails for the key
• The ToPropertyKey implementation for the key fails

pub fn set<K: ToValue<'ducc>, V: ToValue<'ducc>>(
    &self,
    key: K,
    value: V
) -> Result<()>

Sets an object property using the given key and value.

Errors

This function returns an error if:

• ToValue::to_value fails for either the key or the value
• The ToPropertyKey implementation for the key fails

pub fn remove<K: ToValue<'ducc>>(&self, key: K) -> Result<()>

Removes the given key from the object. This function does nothing if the property does not exist.

Errors

This function returns an error if:

• ToValue::to_value fails for the key
• The ToPropertyKey implementation for the key fails

pub fn contains_key<K: ToValue<'ducc>>(&self, key: K) -> Result<bool>

Returns true if the given key is a property of the object, false otherwise.

Errors

This function returns an error if:

• ToValue::to_value fails for the key
• The ToPropertyKey implementation for the key fails

pub fn len(&self) -> Result<usize>

Returns the number of elements in the object using the calculation Math.floor(ToNumber(obj.length)). This function can return an error if the ToNumber implementation fails or if the length getter fails. Returns Ok(0) if the calculation returns a number (a floating point in JavaScript land) outside of the range of usize.

pub fn call_prop<K, A, R>(&self, key: K, args: A) -> Result<R> where
    K: ToValue<'ducc>,
    A: ToValues<'ducc>,
    R: FromValue<'ducc>, 

Calls the function at the key with the given arguments, with this set to the object. Returns an error if the value at the key is not a function.

Important traits for Properties<'ducc, K, V>

impl<'ducc, K, V> Iterator for Properties<'ducc, K, V> where
    K: FromValue<'ducc>,
    V: FromValue<'ducc>,  type Item = Result<(K, V)>;

pub fn properties<K: FromValue<'ducc>, V: FromValue<'ducc>>(
    self
) -> Properties<'ducc, K, V>

Returns an iterator over the object's keys and values, acting like a for-in loop: own and inherited enumerable properties are included, and enumeration order follows the ES2015 OwnPropertyKeys enumeration order, applied for each inheritance level.

Trait Implementations

impl<'ducc> Clone for Object<'ducc>

fn clone(&self) -> Object<'ducc>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'ducc> Debug for Object<'ducc>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<'ducc> FromValue<'ducc> for Object<'ducc>

fn from_value(value: Value<'ducc>, _ducc: &'ducc Ducc) -> Result<Object<'ducc>>

Performs the conversion.

impl<'ducc> ToValue<'ducc> for Object<'ducc>

fn to_value(self, _ducc: &'ducc Ducc) -> Result<Value<'ducc>>

Performs the conversion.