Struct Function 

#[repr(transparent)]
pub struct Function {
    pub obj: JsValue,
}

Fields

obj: JsValue

Implementations

impl Function

pub fn new_with_args(args: &str, body: &str) -> Function

The Function constructor creates a new Function object. Calling the constructor directly can create functions dynamically, but suffers from security and similar (but far less significant) performance issues similar to eval. However, unlike eval, the Function constructor allows executing code in the global scope, prompting better programming habits and allowing for more efficient code minification.

MDN documentation

impl Function

pub fn new_no_args(body: &str) -> Function

The Function constructor creates a new Function object. Calling the constructor directly can create functions dynamically, but suffers from security and similar (but far less significant) performance issues similar to eval. However, unlike eval, the Function constructor allows executing code in the global scope, prompting better programming habits and allowing for more efficient code minification.

MDN documentation

impl Function

pub fn apply(&self, context: &JsValue, args: &Array) -> Result<JsValue, JsValue>

The apply() method calls a function with a given this value, and arguments provided as an array (or an array-like object).

MDN documentation

impl Function

pub fn call0(&self, context: &JsValue) -> Result<JsValue, JsValue>

The call() method calls a function with a given this value and arguments provided individually.

MDN documentation

impl Function

pub fn call1( &self, context: &JsValue, arg1: &JsValue, ) -> Result<JsValue, JsValue>

The call() method calls a function with a given this value and arguments provided individually.

MDN documentation

impl Function

pub fn call2( &self, context: &JsValue, arg1: &JsValue, arg2: &JsValue, ) -> Result<JsValue, JsValue>

The call() method calls a function with a given this value and arguments provided individually.

MDN documentation

impl Function

pub fn call3( &self, context: &JsValue, arg1: &JsValue, arg2: &JsValue, arg3: &JsValue, ) -> Result<JsValue, JsValue>

The call() method calls a function with a given this value and arguments provided individually.

MDN documentation

impl Function

pub fn call4( &self, context: &JsValue, arg1: &JsValue, arg2: &JsValue, arg3: &JsValue, arg4: &JsValue, ) -> Result<JsValue, JsValue>

The call() method calls a function with a given this value and arguments provided individually.

MDN documentation

impl Function

pub fn call5( &self, context: &JsValue, arg1: &JsValue, arg2: &JsValue, arg3: &JsValue, arg4: &JsValue, arg5: &JsValue, ) -> Result<JsValue, JsValue>

The call() method calls a function with a given this value and arguments provided individually.

MDN documentation

impl Function

pub fn call6( &self, context: &JsValue, arg1: &JsValue, arg2: &JsValue, arg3: &JsValue, arg4: &JsValue, arg5: &JsValue, arg6: &JsValue, ) -> Result<JsValue, JsValue>

The call() method calls a function with a given this value and arguments provided individually.

MDN documentation

impl Function

pub fn call7( &self, context: &JsValue, arg1: &JsValue, arg2: &JsValue, arg3: &JsValue, arg4: &JsValue, arg5: &JsValue, arg6: &JsValue, arg7: &JsValue, ) -> Result<JsValue, JsValue>

The call() method calls a function with a given this value and arguments provided individually.

MDN documentation

impl Function

pub fn call8( &self, context: &JsValue, arg1: &JsValue, arg2: &JsValue, arg3: &JsValue, arg4: &JsValue, arg5: &JsValue, arg6: &JsValue, arg7: &JsValue, arg8: &JsValue, ) -> Result<JsValue, JsValue>

The call() method calls a function with a given this value and arguments provided individually.

MDN documentation

impl Function

pub fn call9( &self, context: &JsValue, arg1: &JsValue, arg2: &JsValue, arg3: &JsValue, arg4: &JsValue, arg5: &JsValue, arg6: &JsValue, arg7: &JsValue, arg8: &JsValue, arg9: &JsValue, ) -> Result<JsValue, JsValue>

The call() method calls a function with a given this value and arguments provided individually.

MDN documentation

impl Function

pub fn bind(&self, context: &JsValue) -> Function

The bind() method creates a new function that, when called, has its this keyword set to the provided value, with a given sequence of arguments preceding any provided when the new function is called.

MDN documentation

impl Function

pub fn bind0(&self, context: &JsValue) -> Function

The bind() method creates a new function that, when called, has its this keyword set to the provided value, with a given sequence of arguments preceding any provided when the new function is called.

MDN documentation

impl Function

pub fn bind1(&self, context: &JsValue, arg1: &JsValue) -> Function

The bind() method creates a new function that, when called, has its this keyword set to the provided value, with a given sequence of arguments preceding any provided when the new function is called.

MDN documentation

impl Function

pub fn bind2( &self, context: &JsValue, arg1: &JsValue, arg2: &JsValue, ) -> Function

The bind() method creates a new function that, when called, has its this keyword set to the provided value, with a given sequence of arguments preceding any provided when the new function is called.

MDN documentation

impl Function

pub fn bind3( &self, context: &JsValue, arg1: &JsValue, arg2: &JsValue, arg3: &JsValue, ) -> Function

The bind() method creates a new function that, when called, has its this keyword set to the provided value, with a given sequence of arguments preceding any provided when the new function is called.

MDN documentation

impl Function

pub fn bind4( &self, context: &JsValue, arg1: &JsValue, arg2: &JsValue, arg3: &JsValue, arg4: &JsValue, ) -> Function

The bind() method creates a new function that, when called, has its this keyword set to the provided value, with a given sequence of arguments preceding any provided when the new function is called.

MDN documentation

impl Function

pub fn bind5( &self, context: &JsValue, arg1: &JsValue, arg2: &JsValue, arg3: &JsValue, arg4: &JsValue, arg5: &JsValue, ) -> Function

The bind() method creates a new function that, when called, has its this keyword set to the provided value, with a given sequence of arguments preceding any provided when the new function is called.

MDN documentation

impl Function

pub fn bind6( &self, context: &JsValue, arg1: &JsValue, arg2: &JsValue, arg3: &JsValue, arg4: &JsValue, arg5: &JsValue, arg6: &JsValue, ) -> Function

The bind() method creates a new function that, when called, has its this keyword set to the provided value, with a given sequence of arguments preceding any provided when the new function is called.

MDN documentation

impl Function

pub fn bind7( &self, context: &JsValue, arg1: &JsValue, arg2: &JsValue, arg3: &JsValue, arg4: &JsValue, arg5: &JsValue, arg6: &JsValue, arg7: &JsValue, ) -> Function

The bind() method creates a new function that, when called, has its this keyword set to the provided value, with a given sequence of arguments preceding any provided when the new function is called.

MDN documentation

impl Function

pub fn bind8( &self, context: &JsValue, arg1: &JsValue, arg2: &JsValue, arg3: &JsValue, arg4: &JsValue, arg5: &JsValue, arg6: &JsValue, arg7: &JsValue, arg8: &JsValue, ) -> Function

The bind() method creates a new function that, when called, has its this keyword set to the provided value, with a given sequence of arguments preceding any provided when the new function is called.

MDN documentation

impl Function

pub fn bind9( &self, context: &JsValue, arg1: &JsValue, arg2: &JsValue, arg3: &JsValue, arg4: &JsValue, arg5: &JsValue, arg6: &JsValue, arg7: &JsValue, arg8: &JsValue, arg9: &JsValue, ) -> Function

The bind() method creates a new function that, when called, has its this keyword set to the provided value, with a given sequence of arguments preceding any provided when the new function is called.

MDN documentation

impl Function

pub fn length(&self) -> u32

The length property indicates the number of arguments expected by the function.

MDN documentation

impl Function

pub fn name(&self) -> JsString

A Function object’s read-only name property indicates the function’s name as specified when it was created or “anonymous” for functions created anonymously.

MDN documentation

impl Function

pub fn to_string(&self) -> JsString

The toString() method returns a string representing the source code of the function.

MDN documentation

impl Function

pub fn try_from(val: &JsValue) -> Option<&Function>

👎Deprecated: recommended to use dyn_ref instead which is now equivalent

Returns the Function value of this JS value if it’s an instance of a function.

If this JS value is not an instance of a function then this returns None.

Methods from Deref<Target = Object>

pub fn constructor(&self) -> Function

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

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

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

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

MDN documentation

pub fn to_locale_string(&self) -> JsString

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

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

MDN documentation

pub fn value_of(&self) -> Object

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

MDN documentation

Methods from Deref<Target = JsValue>

pub const NULL: JsValue

pub const UNDEFINED: JsValue

pub const TRUE: JsValue

pub const FALSE: JsValue

pub fn id(&self) -> u64

Get the heap ID for this value.

This is used internally for encoding values to send to JS.

pub fn unchecked_into_f64(&self) -> f64

Returns the value as f64 without type checking. Used by serde-wasm-bindgen for numeric conversions.

pub fn has_type<T>(&self) -> bool

where T: JsCast,

Check if this value is an instance of a specific JS type.

pub fn checked_div(&self, rhs: &JsValue) -> JsValue

Checked division.

pub fn pow(&self, rhs: &JsValue) -> JsValue

Power operation.

pub fn bit_and(&self, rhs: &JsValue) -> JsValue

Bitwise AND.

pub fn bit_or(&self, rhs: &JsValue) -> JsValue

Bitwise OR.

pub fn bit_xor(&self, rhs: &JsValue) -> JsValue

Bitwise XOR.

pub fn bit_not(&self) -> JsValue

Bitwise NOT.

pub fn shl(&self, rhs: &JsValue) -> JsValue

Left shift.

pub fn shr(&self, rhs: &JsValue) -> JsValue

Signed right shift.

pub fn unsigned_shr(&self, rhs: &JsValue) -> u32

Unsigned right shift.

pub fn add(&self, rhs: &JsValue) -> JsValue

Add.

pub fn sub(&self, rhs: &JsValue) -> JsValue

Subtract.

pub fn mul(&self, rhs: &JsValue) -> JsValue

Multiply.

pub fn div(&self, rhs: &JsValue) -> JsValue

Divide.

pub fn rem(&self, rhs: &JsValue) -> JsValue

Remainder.

pub fn neg(&self) -> JsValue

Negate.

pub fn lt(&self, rhs: &JsValue) -> bool

Less than comparison.

pub fn le(&self, rhs: &JsValue) -> bool

Less than or equal comparison.

pub fn gt(&self, rhs: &JsValue) -> bool

Greater than comparison.

pub fn ge(&self, rhs: &JsValue) -> bool

Greater than or equal comparison.

pub fn loose_eq(&self, rhs: &JsValue) -> bool

Loose equality (==).

pub fn is_falsy(&self) -> bool

Check if this value is a falsy value in JavaScript.

pub fn is_truthy(&self) -> bool

Check if this value is a truthy value in JavaScript.

pub fn is_object(&self) -> bool

Check if this value is an object.

pub fn is_function(&self) -> bool

Check if this value is a function.

pub fn is_string(&self) -> bool

Check if this value is a string.

pub fn is_symbol(&self) -> bool

Check if this value is a symbol.

pub fn is_bigint(&self) -> bool

Check if this value is a bigint.

pub fn is_undefined(&self) -> bool

Check if this value is undefined.

pub fn is_null(&self) -> bool

Check if this value is null.

pub fn js_typeof(&self) -> JsValue

Get the typeof this value as a string.

pub fn js_in(&self, obj: &JsValue) -> bool

Check if this value has a property with the given name.

pub fn as_bool(&self) -> Option<bool>

Get the value as a bool.

pub fn as_f64(&self) -> Option<f64>

Get the value as an f64.

pub fn as_string(&self) -> Option<String>

Get the value as a string.

pub fn as_debug_string(&self) -> String

Get a debug string representation of the value.

Trait Implementations

impl AsRef<Function> for Function

fn as_ref(&self) -> &Function

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<JsValue> for Function

fn as_ref(&self) -> &JsValue

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Object> for Function

fn as_ref(&self) -> &Object

Converts this type into a shared reference of the (usually inferred) input type.

impl BatchableResult for Function

fn try_placeholder(batch: &mut Runtime) -> Option<Self>

Returns Some(placeholder) for opaque types that can be batched, None for types that require flushing to get the actual value.

impl BinaryDecode for Function

fn decode(decoder: &mut DecodedData<'_>) -> Result<Self, DecodeError>

impl BinaryEncode for &Function

fn encode(self, encoder: &mut EncodedData)

impl BinaryEncode for Function

fn encode(self, encoder: &mut EncodedData)

impl Clone for Function

fn clone(&self) -> Function

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Function

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

Formats the value using the given formatter.

impl Default for Function

fn default() -> Self

Returns the “default value” for a type.

impl Deref for Function

type Target = Object

The resulting type after dereferencing.

fn deref(&self) -> &Object

Dereferences the value.

impl EncodeTypeDef for Function

fn encode_type_def(buf: &mut Vec<u8>)

Encode this type’s definition into the buffer. For primitives, this is just the TypeTag byte. For callbacks, this includes param count, param types, and return type.

impl From<&Function> for JsValue

fn from(val: &Function) -> Self

Converts to this type from the input type.

impl From<&Function> for Object

fn from(val: &Function) -> Object

Converts to this type from the input type.

impl From<Function> for JsValue

fn from(val: Function) -> Self

Converts to this type from the input type.

impl From<Function> for Object

fn from(val: Function) -> Object

Converts to this type from the input type.

impl From<JsValue> for Function

fn from(val: JsValue) -> Self

Converts to this type from the input type.

impl JsCast for Function

fn instanceof(__val: &JsValue) -> bool

Check if a JsValue is an instance of this type.

fn is_type_of(__val: &JsValue) -> bool

Performs a dynamic type check to see whether the JsValue provided is a value of this type.

fn unchecked_from_js(val: JsValue) -> Self

Unchecked cast from JsValue to this type.

fn unchecked_from_js_ref(val: &JsValue) -> &Self

Unchecked cast from a JsValue reference to a reference of this type.

fn has_type<T>(&self) -> bool

where T: JsCast,

Test whether this JS value has a type T.

fn dyn_into<T>(self) -> Result<T, Self>

where T: JsCast,

Try to cast this value to type T.

fn dyn_ref<T>(&self) -> Option<&T>

where T: JsCast,

Try to get a reference to type T from this value.

fn is_instance_of<T>(&self) -> bool

where T: JsCast,

Test whether this JS value is an instance of the type T.

fn unchecked_into<T>(self) -> T

where T: JsCast,

Unchecked cast to another type.

fn unchecked_ref<T>(&self) -> &T

where T: JsCast,

Unchecked cast to a reference of another type.

impl PartialEq for Function

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Function

impl StructuralPartialEq for Function