Struct js_sys::Function

[+] Show declaration

[+] Expand attributes
#[repr(transparent)]pub struct Function { /* fields omitted */ }

[−] Expand description

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 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 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

Trait Implementations

impl AsRef<Function> for Function[+]

[+] Show hidden undocumented items

fn as_ref(&self) -> &Function[−]

Performs the conversion.

impl AsRef<JsValue> for Function[+]

[+] Show hidden undocumented items

fn as_ref(&self) -> &JsValue[−]

Performs the conversion.

impl AsRef<Object> for Function[+]

[+] Show hidden undocumented items

fn as_ref(&self) -> &Object[−]

Performs the conversion.

impl Clone for Function[+]

[+] Show hidden undocumented items

fn clone(&self) -> Function[−]

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Debug for Function[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Deref for Function[+]

[+] Show hidden undocumented items

type Target = Object

The resulting type after dereferencing.

fn deref(&self) -> &Object[−]

Dereferences the value.

impl Eq for Function

impl From<Function> for JsValue[+]

[+] Show hidden undocumented items

fn from(obj: Function) -> JsValue[−]

Performs the conversion.

impl From<Function> for Object[+]

[+] Show hidden undocumented items

fn from(obj: Function) -> Object[−]

Performs the conversion.

impl From<JsValue> for Function[+]

[+] Show hidden undocumented items

fn from(obj: JsValue) -> Function[−]

Performs the conversion.

impl FromWasmAbi for Function[+]

[+] Show hidden undocumented items

type Abi = <JsValue as FromWasmAbi>::Abi

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

unsafe fn from_abi(js: Self::Abi) -> Self[−]

Recover a Self from Self::Abi.

impl IntoWasmAbi for Function[+]

[+] Show hidden undocumented items

type Abi = <JsValue as IntoWasmAbi>::Abi

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

fn into_abi(self) -> Self::Abi[−]

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl<'a> IntoWasmAbi for &'a Function[+]

[+] Show hidden undocumented items

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

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

fn into_abi(self) -> Self::Abi[−]

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl JsCast for Function[+]

[+] Show hidden undocumented items

fn instanceof(val: &JsValue) -> bool[−]

Performs a dynamic instanceof check to see whether the JsValue provided is an instance of this type.

fn is_type_of(val: &JsValue) -> bool[−]

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

fn unchecked_from_js(val: JsValue) -> Self[−]

Performs a zero-cost unchecked conversion from a JsValue into an instance of Self

fn unchecked_from_js_ref(val: &JsValue) -> &Self[−]

Performs a zero-cost unchecked conversion from a &JsValue into an instance of &Self.

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, [−]

Performs a dynamic cast (checked at runtime) of this value into the target type T.

fn dyn_ref<T>(&self) -> Option<&T> where
    T: JsCast, [−]

Performs a dynamic cast (checked at runtime) of this value into the target type T.

fn unchecked_into<T>(self) -> T where
    T: JsCast, [−]

Performs a zero-cost unchecked cast into the specified type.

fn unchecked_ref<T>(&self) -> &T where
    T: JsCast, [−]

Performs a zero-cost unchecked cast into a reference to the specified type.

fn is_instance_of<T>(&self) -> bool where
    T: JsCast, [−]

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

impl OptionFromWasmAbi for Function[+]

[+] Show hidden undocumented items

fn is_none(abi: &Self::Abi) -> bool[−]

Tests whether the argument is a "none" instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for Function[+]

[+] Show hidden undocumented items

fn none() -> Self::Abi[−]

Returns an ABI instance indicating "none", which JS will interpret as the None branch of this option.

impl<'a> OptionIntoWasmAbi for &'a Function[+]

[+] Show hidden undocumented items

fn none() -> Self::Abi[−]

Returns an ABI instance indicating "none", which JS will interpret as the None branch of this option.

impl PartialEq<Function> for Function[+]

[+] Show hidden undocumented items

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

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Function) -> bool[−]

This method tests for !=.

impl RefFromWasmAbi for Function[+]

[+] Show hidden undocumented items

type Abi = <JsValue as RefFromWasmAbi>::Abi

The wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<Function>

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.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor[−]

Recover a Self::Anchor from Self::Abi.

impl StructuralEq for Function

impl StructuralPartialEq for Function

impl WasmDescribe for Function[+]

[+] Show hidden undocumented items

fn describe()