Struct rquickjs_core::Function

pub struct Function<'js>(_);

Rust representation of a javascript function.

Implementations

impl<'js> Function<'js>

pub fn new<F, A, R>(ctx: Ctx<'js>, func: F) -> Result<Self> where
    F: AsFunction<'js, A, R> + ParallelSend + 'static, 

pub fn set_length(&self, len: usize) -> Result<()>

Set the length property

pub fn set_name<S: AsRef<str>>(&self, name: S) -> Result<()>

Set the name property

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

Call a function with given arguments

You can use tuples to pass arguments. The () treated as no arguments, the (arg,) as a single argument and so on.

To call function on a given this you can pass This(this) as a first argument. By default an undefined will be passed as this.

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

Call a constructor with given arguments

You can use tuples to pass arguments. The () treated as no arguments, the (arg,) as a single argument and so on.

To call constructor on a given this you can pass This(this) as a first argument.

pub fn defer_call<A>(&self, args: A) -> Result<()> where
    A: AsArguments<'js>, 

Deferred call a function with given arguments

You can use tuples to pass arguments. The () treated as no arguments, the (arg,) as a single argument and so on.

To call function on a given this you can pass This(this) as a first argument. By default an undefined will be passed as this.

pub fn is_constructor(&self) -> bool

Check that function is a constructor

pub fn set_constructor(&self, flag: bool)

Mark the function as a constructor

pub fn set_prototype(&self, proto: &Object<'js>)

Set a function prototype

Actually this method does the following:

func.prototype = proto;
proto.constructor = func;

pub fn get_prototype(&self) -> Result<Object<'js>>

Get a function prototype

Actually this method returns the func.prototype.

pub fn as_object(&self) -> &Object<'js>

Reference as an object

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

Convert into an object

pub fn from_object(object: Object<'js>) -> Result<Self>

Convert from an object

impl<'js> Function<'js>

pub fn as_value(&self) -> &Value<'js>

Reference to value

pub fn into_value(self) -> Value<'js>

Convert into value

pub fn from_value(value: Value<'js>) -> Result<Self>

Convert from value

Methods from Deref<Target = Value<'js>>

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

Try get bool from value

pub fn as_int(&self) -> Option<i32>

Try get int from value

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

Try get float from value

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

Try get any number from value

pub fn is_bool(&self) -> bool

Check if the value is a bool

pub fn is_int(&self) -> bool

Check if the value is an int

pub fn is_float(&self) -> bool

Check if the value is a float

pub fn is_number(&self) -> bool

Check if the value is an any number

pub fn is_string(&self) -> bool

Check if the value is a string

pub fn is_symbol(&self) -> bool

Check if the value is a symbol

pub fn is_object(&self) -> bool

Check if the value is an object

pub fn is_module(&self) -> bool

Check if the value is a module

pub fn is_array(&self) -> bool

Check if the value is an array

pub fn is_function(&self) -> bool

Check if the value is a function

pub fn is_error(&self) -> bool

Check if the value is an error

pub fn as_value(&self) -> &Self

Reference as value

pub fn get<T: FromJs<'js>>(&self) -> Result<T>

Convert from value to specified type

pub fn type_of(&self) -> Type

Get the type of value

pub fn type_name(&self) -> &'static str

Get the name of type

pub unsafe fn ref_string(&self) -> &String<'js>

Interprete as

Safety

You should be sure that the value already is of required type before to do it.

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

Try reinterprete as

pub unsafe fn ref_symbol(&self) -> &Symbol<'js>

Interprete as

Safety

You should be sure that the value already is of required type before to do it.

pub fn as_symbol(&self) -> Option<&Symbol<'js>>

Try reinterprete as

pub unsafe fn ref_object(&self) -> &Object<'js>

Interprete as

Safety

You should be sure that the value already is of required type before to do it.

pub fn as_object(&self) -> Option<&Object<'js>>

Try reinterprete as

pub unsafe fn ref_array(&self) -> &Array<'js>

Interprete as

Safety

You should be sure that the value already is of required type before to do it.

pub fn as_array(&self) -> Option<&Array<'js>>

Try reinterprete as

pub unsafe fn ref_function(&self) -> &Function<'js>

Interprete as

Safety

You should be sure that the value already is of required type before to do it.

pub fn as_function(&self) -> Option<&Function<'js>>

Try reinterprete as

pub unsafe fn ref_module(&self) -> &Module<'js, Evaluated>

Interprete as

Safety

You should be sure that the value already is of required type before to do it.

pub fn as_module(&self) -> Option<&Module<'js, Evaluated>>

Try reinterprete as

Trait Implementations

impl<'js> AsRef<Value<'js>> for Function<'js>

fn as_ref(&self) -> &Value<'js>

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

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> Deref for Function<'js>

type Target = Value<'js>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'js> From<Function<'js>> for Value<'js>

fn from(value: Function<'js>) -> Self

Converts to this type from the input type.

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

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

impl<'js> IntoAtom<'js> for Function<'js>

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

impl<'js> IntoJs<'js> for Function<'js>

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

impl<'js, 't> Outlive<'t> for Function<'js>

type Target = Function<'t>

The target which has the same type as a Self but with another lifetime 't

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: &Rhs) -> bool

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

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