Struct Function 

pub struct Function<'f> {
    function: Local<'f, *mut JSFunction>,
}

Represents a Function within the JavaScript Runtime. Refer to MDN for more details.

Fields

function: Local<'f, *mut JSFunction>

Implementations

impl<'f> Function<'f>

pub fn new( cx: &'f Context, name: &str, func: Option<NativeFunction>, nargs: u32, flags: PropertyFlags, ) -> Function<'f>

Creates a new Function with the given name, native function, number of arguments and flags.

pub fn from_spec(cx: &'f Context, spec: &JSFunctionSpec) -> Function<'f>

Creates a new Function with the given spec.

pub fn from_closure_once( cx: &'f Context, name: &CStr, closure: Box<ClosureOnce>, nargs: u32, flags: PropertyFlags, ) -> Function<'f>

Creates a new Function with a ClosureOnce.

Throws a JS Exception if called more than once.

pub fn from_closure( cx: &'f Context, name: &CStr, closure: Box<Closure>, nargs: u32, flags: PropertyFlags, ) -> Function<'f>

Creates a new Function with a Closure.

fn create_with_closure( cx: &'f Context, call: NativeFunction, name: &CStr, closure: &Object<'_>, nargs: u32, flags: PropertyFlags, ) -> Function<'f>

pub fn from_object( cx: &'f Context, obj: &Local<'_, *mut JSObject>, ) -> Option<Function<'f>>

Creates a new Function from an object. Returns None if the object is not a function.

pub fn to_object(&self, cx: &'f Context) -> Object<'f>

Converts the Function into an Object.

pub fn to_string(&self, cx: &Context) -> Option<String>

Converts the Function into a String in the form of its definition/source.

pub fn name(&self, cx: &Context) -> Result<String>

Returns the name of the function.

pub fn display_name(&self, cx: &Context) -> Result<String>

Returns the display name of the function. Function display names are a non-standard feature. Refer to MDN for more details.

pub fn nargs(&self) -> u16

Returns the number of arguments of the function.

pub fn length(&self, cx: &Context) -> Option<u16>

Returns the length of the source of the function.

pub fn call<'cx>( &self, cx: &'cx Context, this: &Object<'_>, args: &[Value<'_>], ) -> Result<Value<'cx>, Option<ErrorReport>>

Calls the Function with the given this Object and arguments. Returns the result of the Function as a Value. Returns Err if the function call fails or an exception occurs.

pub fn call_with_handle<'cx>( &self, cx: &'cx Context, this: &Object<'_>, args: HandleValueArray, ) -> Result<Value<'cx>, Option<ErrorReport>>

Calls the Function with the given this Object and arguments as a HandleValueArray. Returns the result of the Function as a Value. Returns Err if the function call fails or an exception occurs.

pub fn is_eval(&self) -> bool

Checks if the Function is the built-in eval function.

pub fn is_constructor(&self) -> bool

Checks if the Function is a constructor.

pub fn is_function_constructor(&self) -> bool

Checks if the Function is the built-in function constructor.

pub unsafe fn is_function_raw(obj: *mut JSObject) -> bool

Checks if [a raw object](*mut JSObject) is a function.

Methods from Deref<Target = Local<'f, *mut JSFunction>>

pub fn handle(&self) -> Handle<'local, T>

Forms a Handle to the Local which can be passed to SpiderMonkey APIs.

pub fn get(&self) -> T

Trait Implementations

impl<'f> Debug for Function<'f>

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

Formats the value using the given formatter.

impl<'f> Deref for Function<'f>

type Target = Local<'f, *mut JSFunction>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'f> From<Local<'f, *mut JSFunction>> for Function<'f>

fn from(function: Local<'f, *mut JSFunction>) -> Function<'f>

Converts to this type from the input type.

impl<'cx> FromValue<'cx> for Function<'cx>

type Config = ()

fn from_value( cx: &'cx Context, value: &Value<'_>, _: bool, _: (), ) -> Result<Function<'cx>>

Converts value to the desired type. strict and config determine the strictness of the conversion and specify additional conversion constraints respectively. Returns Err with the error if conversion fails.

impl<'cx> ToValue<'cx> for Function<'cx>

fn to_value(&self, cx: &'cx Context, value: &mut Value<'_>)

Converts self to a Value and stores it in value.

fn as_value(&self, cx: &'cx Context) -> Value<'cx>

Converts self to a new Value.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 16 bytes