[][src]Struct js_sys::Function

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

Implementations

impl Function[src]

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

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[src]

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

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[src]

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

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[src]

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

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

MDN documentation

impl Function[src]

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

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

MDN documentation

impl Function[src]

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

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

MDN documentation

impl Function[src]

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

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

MDN documentation

impl Function[src]

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

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[src]

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

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[src]

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

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[src]

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

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[src]

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

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[src]

pub fn length(&self) -> u32[src]

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

MDN documentation

impl Function[src]

pub fn name(&self) -> JsString[src]

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[src]

pub fn to_string(&self) -> JsString[src]

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

MDN documentation

impl Function[src]

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

👎 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[src]

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[src]

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[src]

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[src]

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

MDN documentation

pub fn to_locale_string(&self) -> JsString[src]

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[src]

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

MDN documentation

pub fn value_of(&self) -> Object[src]

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

MDN documentation

Methods from Deref<Target = JsValue>

pub const NULL: JsValue[src]

pub const UNDEFINED: JsValue[src]

pub const TRUE: JsValue[src]

pub const FALSE: JsValue[src]

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

Returns the f64 value of this JS value if it's an instance of a number.

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

pub fn is_string(&self) -> bool[src]

Tests whether this JS value is a JS string.

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

If this JS value is a string value, this function copies the JS string value into wasm linear memory, encoded as UTF-8, and returns it as a Rust String.

To avoid the copying and re-encoding, consider the JsString::try_from() function from js-sys instead.

If this JS value is not an instance of a string or if it's not valid utf-8 then this returns None.

UTF-16 vs UTF-8

JavaScript strings in general are encoded as UTF-16, but Rust strings are encoded as UTF-8. This can cause the Rust string to look a bit different than the JS string sometimes. For more details see the documentation about the str type which contains a few caveats about the encodings.

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

Returns the bool value of this JS value if it's an instance of a boolean.

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

pub fn is_null(&self) -> bool[src]

Tests whether this JS value is null

pub fn is_undefined(&self) -> bool[src]

Tests whether this JS value is undefined

pub fn is_symbol(&self) -> bool[src]

Tests whether the type of this JS value is symbol

pub fn is_object(&self) -> bool[src]

Tests whether typeof self == "object" && self !== null.

pub fn is_function(&self) -> bool[src]

Tests whether the type of this JS value is function.

pub fn is_truthy(&self) -> bool[src]

Tests whether the value is "truthy".

pub fn is_falsy(&self) -> bool[src]

Tests whether the value is "falsy".

Trait Implementations

impl AsRef<Function> for Function[src]

impl AsRef<JsValue> for Function[src]

impl AsRef<Object> for Function[src]

impl Clone for Function[src]

impl Debug for Function[src]

impl Deref for Function[src]

type Target = Object

The resulting type after dereferencing.

impl Eq for Function[src]

impl From<Function> for JsValue[src]

impl From<Function> for Object[src]

impl From<JsValue> for Function[src]

impl FromWasmAbi for Function[src]

type Abi = <JsValue as FromWasmAbi>::Abi

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

impl IntoWasmAbi for Function[src]

type Abi = <JsValue as IntoWasmAbi>::Abi

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

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

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

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

impl JsCast for Function[src]

impl OptionFromWasmAbi for Function[src]

impl OptionIntoWasmAbi for Function[src]

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

impl PartialEq<Function> for Function[src]

impl RefFromWasmAbi for Function[src]

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. Read more

impl StructuralEq for Function[src]

impl StructuralPartialEq for Function[src]

impl WasmDescribe for Function[src]

Auto Trait Implementations

impl RefUnwindSafe for Function[src]

impl !Send for Function[src]

impl !Sync for Function[src]

impl Unpin for Function[src]

impl UnwindSafe for Function[src]

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> ReturnWasmAbi for T where
    T: IntoWasmAbi
[src]

type Abi = <T as IntoWasmAbi>::Abi

Same as IntoWasmAbi::Abi

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.