Struct JSObject

Source

pub struct JSObject<'a> { /* private fields */ }

Expand description

A JavaScript object.

Implementations§

Source §

impl<'a> JSObject<'a>

Source

pub fn new(ctx: &'a JSContext) -> Self

Create a new default javascript object.

Source

pub fn new_function_with_callback<F>(ctx: &'a JSContext, callback: F) -> Self
where for<'c> F: FnMut(&'c JSContext, &JSObject<'c>, &[JSValue<'c>]) -> Result<JSValue<'c>, JSValue<'c>>,

Create a JavaScript function with a given callback as its implementation.

Results in a JSObject that is a function. The object’s prototype will be the default function prototype.

This can be used to execute Rust code from JavaScript.

Source

pub fn new_function( ctx: &'a JSContext, name: Option<&str>, param_names: &[&str], body: &str, source_url: Option<&str>, starting_line_number: i32, ) -> Result<Self, JSValue<'a>>

Creates a function with a given script as its body.

Use this method when you want to execute a script repeatedly, to avoid the cost of re-parsing the script before each execution.

Can return Err if there was an exception when creating the function or if the script or parameters contain syntax errors.

Source

pub fn new_array( ctx: &'a JSContext, items: &[JSValue<'_>], ) -> Result<Self, JSValue<'a>>

Creates a JavaScript Array object.

Source

pub fn is_function(&self) -> bool

Tests whether an object can be called as a function.

Source

pub fn is_constructor(&self) -> bool

Tests whether an object can be called as a constructor.

Source

pub fn call_as_function( &self, this: Option<&JSObject<'_>>, args: &[JSValue<'_>], ) -> Result<JSValue<'_>, JSValue<'_>>

Calls an object as a function.

Return the JSValue that results from calling object as a function, or Err if an exception is thrown or object is not a function.

Source

pub fn call_as_constructor( &self, args: &[JSValue<'_>], ) -> Result<JSObject<'_>, JSValue<'_>>

Calls an object as a constructor.

Return the JSObject that results from calling object as a constructor, or Err if an exception is thrown or object is not a constructor.

Source §

impl JSObject<'_>

Source

pub fn get_property(&self, name: &str) -> Result<JSValue<'_>, JSValue<'_>>

Gets a property from an object by name.

Returns the property’s value if object has the property, otherwise the undefined value, or Err if an exception is thrown.

Source

pub fn get_property_at_index( &self, index: u32, ) -> Result<JSValue<'_>, JSValue<'_>>

Gets a property from an object by numeric index.

Returns the property’s value if object has the property, otherwise the undefined value, or Err if an exception is thrown.

Calling JSObject::get_property_at_index is equivalent to calling JSObject::get_property with a string containing index, but JSObject::get_property_at_index provides optimized access to numeric properties.

Source

pub fn set_property( &self, name: &str, value: &JSValue<'_>, attributes: JSPropertyAttributes, ) -> Result<(), JSValue<'_>>

Sets a property on an object by name.

Returns Err if an exception is thrown.

Source

pub fn set_property_at_index( &self, index: u32, value: &JSValue<'_>, ) -> Result<(), JSValue<'_>>

Sets a property on an object by numeric index.

Returns Err if an exception is thrown.

Calling JSObject::set_property_at_index is equivalent to calling JSObject::set_property with a string containing index, but JSObject::set_property_at_index provides optimized access to numeric properties.

Source

pub fn get_property_names(&self) -> JSPropertyNameArray<'_>

Gets the names of an object’s enumerable properties.

Source

pub fn has_property(&self, name: &str) -> bool

Tests whether an object has a property.

Source

pub fn delete_property(&self, name: &str) -> Result<bool, JSValue<'_>>

Deletes a property from an object by name.

Returns true if the property was deleted, false if the property was not present, or it had JSPropertyAttributes::dont_delete set, or Err if an exception is thrown.

Source

pub fn get_property_for_key( &self, key: &JSValue<'_>, ) -> Result<JSValue<'_>, JSValue<'_>>

Gets a property from an object using a JSValue as the property key.

Returns the property’s value if object has the property, otherwise the undefined value, or Err if an exception is thrown.

This function is the same as performing object[propertyKey](propertyKey) from JavaScript.

Source

pub fn set_property_for_key( &self, key: &JSValue<'_>, value: &JSValue<'_>, attributes: JSPropertyAttributes, ) -> Result<(), JSValue<'_>>

Sets a property on an object using a JSValue as the property key.

Returns Err if an exception is thrown.

This function is the same as performing object[propertyKey](propertyKey) = value from JavaScript.

Source

pub fn has_property_for_key( &self, key: &JSValue<'_>, ) -> Result<bool, JSValue<'_>>

Tests whether an object has a given property using a JSValue as the property key.

This function is the same as performing propertyKey in object from JavaScript.

Source

pub fn delete_property_for_key( &self, key: &JSValue<'_>, ) -> Result<bool, JSValue<'_>>

Deletes a property from an object using a JSValue as the property key.

Returns true if the property was deleted, false if the property was not present, or it had JSPropertyAttributes::dont_delete set, or Err if an exception is thrown.

This function is the same as performing delete object[propertyKey](propertyKey) from JavaScript.