Struct rquickjs::Function

pub struct Function<'js>(_);

Rust representation of a javascript function.

Methods

impl<'js> Function<'js>

pub fn new_static<F, N>(ctx: Ctx<'js>, name: N) -> Result<Self> where
    N: Into<Vec<u8>>,
    F: StaticFn<'js>, 

Create a new static function.

Static functions do not have any context unlike closures and must implement StaticFn. Static functions have minimal overhead compared to other functions but have more restrictions and require a type to 'carry' the function.

Example

use rquickjs::function::StaticFn;

fn print<'js>(ctx: Ctx<'js>, _this: (), args: (String,)) -> Result<()>{
    println!("{}",args.0);
    Ok(())
}

static_fn!(print,FnPrint,(), (String,),());

context.with(|ctx|{
    let print = Function::new_static::<FnPrint,_>(ctx, "print").unwrap();
    ctx.globals().set("print", print);
    // prints 'hello from javascript' to stdout
    ctx.eval::<(),_>("print('hello from javascript!'); ");
});

pub fn new<F, A, T, R, N>(ctx: Ctx<'js>, name: N, func: F) -> Result<Self> where
    N: Into<Vec<u8>>,
    A: FromJsMulti<'js>,
    T: FromJs<'js>,
    R: ToJs<'js>,
    F: FnMut(Ctx<'js>, T, A) -> Result<R> + 'static, 

pub fn call<A, R>(&self, args: A) -> Result<R> where
    A: ToJsMulti<'js>,
    R: FromJs<'js>, 

Call a function with given arguments with the this as the global context object.

pub fn call_on<A, T, R>(&self, this: T, args: A) -> Result<R> where
    A: ToJsMulti<'js>,
    R: FromJs<'js>,
    T: ToJs<'js>, 

Call a function with given arguments on a given this

pub fn into_object(self) -> Object<'js>

Trait Implementations

impl<'js> Clone for Function<'js>

fn clone(&self) -> Function<'js>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'js> Debug for Function<'js>

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

Formats the value using the given formatter.

impl<'js> FromJs<'js> for Function<'js>

fn from_js(_: Ctx<'js>, value: Value<'js>) -> Result<Self>

impl<'js> PartialEq<Function<'js>> for Function<'js>

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

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

fn ne(&self, other: &Function<'js>) -> bool

This method tests for !=.

impl<'js> StructuralPartialEq for Function<'js>

impl<'js> ToAtom<'js> for Function<'js>

fn to_atom(self, ctx: Ctx<'js>) -> Atom<'js>

impl<'js> ToJs<'js> for Function<'js>

fn to_js(self, _: Ctx<'js>) -> Result<Value<'js>>