Struct ArgReader 

pub struct ArgReader<'a> { /* private fields */ }

Typed argument reader wrapping SpiderMonkey CallArgs.

Provides safe extraction of typed arguments from JS function calls.

Implementations

impl<'a> ArgReader<'a>

pub unsafe fn new(cx: *mut JSContext, args: &'a CallArgs) -> ArgReader<'a>

Create an ArgReader from a JSContext and CallArgs.

Safety

cx must be a valid JSContext. args must be valid CallArgs for the current call.

pub fn argc(&self) -> u32

Number of arguments passed.

pub fn has(&self, index: u32) -> bool

Check if argument at index exists.

pub unsafe fn get_raw(&self, index: u32) -> Value

Get raw JSVal at index, or UndefinedValue if out of bounds.

Safety

cx must be a valid JSContext. index must be in bounds or handled gracefully.

pub unsafe fn get_string(&self, index: u32) -> String

Extract a string argument. Returns default if missing or not a string.

Safety

Must be called within a valid JSContext scope.

pub unsafe fn get_optional_string(&self, index: u32) -> Option<String>

Extract an optional string argument.

Safety

Must be called within a valid JSContext scope.

pub unsafe fn get_int(&self, index: u32) -> i32

Extract an i32 argument. Returns default if missing or not a number.

Safety

Must be called within a valid JSContext scope.

pub unsafe fn get_f64(&self, index: u32) -> f64

Extract an f64 argument. Returns default if missing or not a number.

Safety

Must be called within a valid JSContext scope.

pub unsafe fn get_bool(&self, index: u32) -> bool

Extract a bool argument. Returns false if missing or not a boolean.

Safety

Must be called within a valid JSContext scope.

pub unsafe fn get_object(&self, index: u32) -> *mut JSObject

Extract a JSObject pointer argument. Returns null if missing or not an object.

Safety

Must be called within a valid JSContext scope.

pub unsafe fn get_value(&self, index: u32) -> JsValue

Extract a JsValue at index.

Safety

Must be called within a valid JSContext scope.

pub unsafe fn return_undefined(&self)

Set the return value to undefined.

Safety

Must be called within a valid JSContext scope.

pub unsafe fn return_value(&self, val: JsValue)

Set the return value to a JsValue.

Safety

Must be called within a valid JSContext scope.

pub unsafe fn return_bool(&self, v: bool)

Set the return value to a bool.

Safety

Must be called within a valid JSContext scope.

pub unsafe fn return_int(&self, v: i32)

Set the return value to an i32.

Safety

Must be called within a valid JSContext scope.

pub unsafe fn return_f64(&self, v: f64)

Set the return value to an f64.

Safety

Must be called within a valid JSContext scope.

pub unsafe fn return_string(&self, s: &str)

Set the return value to a Rust string (creates a JSString).

Safety

Must be called within a valid JSContext scope.

pub unsafe fn throw(&self, msg: &str) -> bool

Throw an error message on the JSContext and return false.

Safety

Must be called within a valid JSContext scope.