Struct qjs::Local

pub struct Local<'a, T> where
    T: Unbindable,  { /* fields omitted */ }

Methods

impl<'a> Local<'a, Value>

pub fn ok(self) -> Result<Local<'a, Value>, Error>

impl<'a> Local<'a, Value>

pub fn call<T: Args>(
    &self,
    this: Option<&Value>,
    args: T
) -> Result<Local<Value>, Error>

pub fn invoke<N: NewAtom, T: Args>(
    &self,
    atom: N,
    args: T
) -> Result<Local<Value>, Error>

pub fn call_constructor<T: Args>(&self, args: T) -> Result<Local<Value>, Error>

pub fn call_constructor2<T: Args>(
    &self,
    new_target: Option<&Value>,
    args: T
) -> Result<Local<Value>, Error>

impl<'a, T> Local<'a, T> where
    T: Unbindable, 

pub fn into_inner(self) -> T

pub fn map<U, F>(self, f: F) -> Local<'a, U> where
    F: FnOnce(T) -> U,
    U: Unbindable, 

impl<'_> Local<'_, Value>

pub fn write_bytecode(&self) -> Result<Vec<u8>, Error>

impl<'a> Local<'a, Value>

pub fn keys(&self) -> Result<Option<Vec<Atom>>, Error>

Returns an array of a given object's own property names, in the same order as we get with a normal loop.

pub fn get_own_property_names(&self) -> Result<Option<Vec<Atom>>, Error>

Returns an array of all properties (including non-enumerable properties except for those which use Symbol) found directly in a given object.

pub fn get_own_property_descriptor<T: NewAtom>(
    &self,
    prop: T
) -> Result<Option<Descriptor>, Error>

Returns a property descriptor for an own property (that is, one directly present on an object and not in the object's prototype chain) of a given object.

pub fn get_property<T: GetProperty>(&self, prop: T) -> Option<Local<Value>>

Get a property value on an object.

pub fn set_property<T: SetProperty, V: NewValue>(
    &self,
    prop: T,
    val: V
) -> Result<bool, Error>

Set a property value on an object.

pub fn has_property<T: HasProperty>(&self, prop: T) -> Result<bool, Error>

Check if a property on an object.

pub fn delete_property<T: DeleteProperty>(&self, prop: T) -> Result<bool, Error>

Delete a property on an object.

It returns a bool indicating whether or not the property was successfully deleted.

pub fn define_property<T: DefineProperty>(
    &self,
    prop: T,
    val: Option<Value>,
    getter: Option<&Value>,
    setter: Option<&Value>,
    flags: Prop
) -> Result<bool, Error>

Defines a new property directly on an object, or modifies an existing property on an object.

pub fn define_property_value<T: DefinePropertyValue, V: NewValue>(
    &self,
    prop: T,
    val: V,
    flags: Prop
) -> Result<bool, Error>

Defines a new property with value directly on an object, or modifies an existing property on an object.

pub fn define_property_get_set<T: DefinePropertyGetSet>(
    &self,
    prop: T,
    getter: Option<&Value>,
    setter: Option<&Value>,
    flags: Prop
) -> Result<bool, Error>

Defines a new property with getter and setter directly on an object, or modifies an existing property on an object.

pub fn is_extensible(&self) -> Result<bool, Error>

Check if an object is extensible (whether it can have new properties added to it).

pub fn prevent_extensions(&self) -> Result<bool, Error>

Prevents new properties from ever being added to an object (i.e. prevents future extensions to the object).

impl<'_> Local<'_, Value>

pub fn get_opaque<T>(&self, class_id: ClassId) -> *mut T

impl<'a> Local<'a, Value>

pub fn check_undefined(self) -> Option<Local<'a, Value>>

pub fn is_error(&self) -> bool

pub fn is_function(&self) -> bool

pub fn is_constructor(&self) -> bool

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

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

pub fn to_int64(&self) -> Option<i64>

pub fn to_index(&self) -> Option<u64>

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

pub fn to_bigint64(&self) -> Option<i64>

pub fn to_str(&self) -> Local<Value>

pub fn to_property_key(&self) -> Local<Value>

pub fn to_cstring(&self) -> Option<CString>

pub fn instance_of(&self, obj: &Value) -> Result<bool, Error>

Trait Implementations

impl<'_> GetProperty for Local<'_, JSAtom>

fn get_property<'a>(
    &self,
    ctxt: &'a ContextRef,
    this: &Value
) -> Option<Local<'a, Value>>

Get a property value on an object.

impl<'_> SetProperty for Local<'_, JSAtom>

fn set_property<T: NewValue>(
    &self,
    ctxt: &ContextRef,
    this: &Value,
    val: T
) -> Result<bool, Error>

Set a property value on an object.

impl<'_> DefinePropertyValue for Local<'_, JSAtom>

fn define_property<T: NewValue>(
    self,
    ctxt: &ContextRef,
    this: &Value,
    val: T,
    flags: Prop
) -> Result<bool, Error>

Defines a new property with value directly on an object, or modifies an existing property on an object.

impl<'a> NewValue for Local<'a, Value>

fn new_value(self, _ctxt: &ContextRef) -> JSValue

impl<'a> NewValue for &'a Local<'a, Value>

fn new_value(self, ctxt: &ContextRef) -> JSValue

impl<'a, T> Drop for Local<'a, T> where
    T: Unbindable, 

fn drop(&mut self)

Executes the destructor for this type.

impl<'a> Into<Value> for Local<'a, Value>

fn into(self) -> Value

Performs the conversion.

impl<'a> Into<JSValue> for Local<'a, Value>

fn into(self) -> JSValue

Performs the conversion.

impl<'_, T: ExtractValue + PartialOrd> PartialOrd<T> for Local<'_, Value>

fn partial_cmp(&self, other: &T) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use] fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use] fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use] fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use] fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'_, T: ExtractValue + PartialEq> PartialEq<T> for Local<'_, Value>

fn eq(&self, other: &T) -> bool

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'_> Clone for Local<'_, Value>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, T> DerefMut for Local<'a, T> where
    T: Unbindable, 

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'a, T> Deref for Local<'a, T> where
    T: Unbindable, 

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<'_> Display for Local<'_, Value>

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

Formats the value using the given formatter.

impl<'_> Debug for Local<'_, Value>

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

Formats the value using the given formatter.

impl<'_> TryFrom<Local<'_, Value>> for ErrorKind

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Local<Value>) -> Result<Self, Self::Error>

Performs the conversion.