Struct Arguments 

pub struct Arguments<'cx> {
    cx: &'cx Context,
    args: u16,
    callee: Object<'cx>,
    call_args: CallArgs,
}

Represents Arguments to a JavaScript Function. Wrapper around CallArgs to provide lifetimes and root all arguments.

Fields

cx: &'cx Context

args: u16

callee: Object<'cx>

call_args: CallArgs

Implementations

impl<'cx> Arguments<'cx>

pub unsafe fn new(cx: &'cx Context, argc: u32, vp: *mut JSVal) -> Arguments<'cx>

pub fn check_args( &self, cx: &Context, min: u16, key: Option<&str>, ) -> Result<()>

Checks if the expected minimum number of arguments were passed.

pub fn len(&self) -> u16

Returns the number of arguments.

pub fn is_empty(&self) -> bool

Returns true if there are no arguments.

pub fn cx(&self) -> &'cx Context

Returns the context associated with the arguments.

pub fn callee(&self) -> Object<'cx>

Returns the value of the function being called.

pub fn this(&self) -> Value<'cx>

Returns the this value of the function. Refer to MDN for more details.

pub fn rval(&mut self) -> Value<'cx>

Returns the return value of the function. This value can be modified to change the return value.

pub fn new_target(&self) -> Option<Value<'cx>>

Returns the new target of the function if it is constructing.

pub fn value(&self, index: u16) -> Option<Value<'cx>>

Returns the argument at a given index.

pub fn is_constructing(&self) -> bool

Returns true if the function was called with new.

pub fn ignores_return_value(&self) -> bool

Returns true if the function ignores the return value.

pub fn call_args(&self) -> &CallArgs

pub fn access<'a>(&'a mut self) -> Accessor<'a, 'cx>

Trait Implementations

impl<'a, 'cx> FromArgument<'a, 'cx> for &'a mut Arguments<'cx>

type Config = ()

fn from_argument( accessor: &'a mut Accessor<'_, 'cx>, _: (), ) -> Result<&'a mut Arguments<'cx>>

Converts from an argument.

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: 48 bytes