Struct rquickjs_core::Value

pub struct Value<'js> { /* private fields */ }

Any javascript value

Implementations

impl<'js> Value<'js>

pub fn new_uninitialized(ctx: Ctx<'js>) -> Self

pub fn new_undefined(ctx: Ctx<'js>) -> Self

pub fn new_null(ctx: Ctx<'js>) -> Self

pub fn new_bool(ctx: Ctx<'js>, value: bool) -> Self

Create new boolean value

pub fn ctx(&self) -> &Ctx<'js>

Returns the Ctx object associated with this value.

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

Try get bool from value

pub fn new_int(ctx: Ctx<'js>, value: i32) -> Self

Create new int value

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

Try get int from value

pub fn new_float(ctx: Ctx<'js>, value: f64) -> Self

Create new float value

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

Try get float from value

pub fn new_number(ctx: Ctx<'js>, value: f64) -> Self

Create a new number value

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

Try get any number from value

pub fn is_null(&self) -> bool

Returns if the value is the JavaScript null value.

pub fn is_undefined(&self) -> bool

Returns if the value is the JavaScript undefined 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_constructor(&self) -> bool

Check if the value is a constructor function

pub fn is_exception(&self) -> bool

Check if the value is a constructor 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 as_raw(&self) -> JSValue

Returns the raw C library javascript value.

pub unsafe fn from_raw(ctx: Ctx<'js>, value: JSValue) -> Self

Create a value from the C library JavaScript value.

Safety

the value cannot be from an unrelated runtime and the value must be owned. Quickjs javascript values are reference counted. The drop implementation of this type decrements the referece count so the value must have count which won’t be decremented elsewhere. Use qjs::JS_DupValue to increment the reference count of the value.

impl<'js> Value<'js>

pub fn type_of(&self) -> Type

Get the type of value

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

Get the name of type

impl<'js> Value<'js>

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 fn into_string(self) -> Option<String<'js>>

Try convert into

pub fn try_into_string(self) -> Result<String<'js>, Value<'js>>

Try convert into returning self if the conversion fails

pub fn from_string(value: String<'js>) -> Self

Convert from

impl<'js> Value<'js>

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 fn into_symbol(self) -> Option<Symbol<'js>>

Try convert into

pub fn try_into_symbol(self) -> Result<Symbol<'js>, Value<'js>>

Try convert into returning self if the conversion fails

pub fn from_symbol(value: Symbol<'js>) -> Self

Convert from

impl<'js> Value<'js>

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 fn into_object(self) -> Option<Object<'js>>

Try convert into

pub fn try_into_object(self) -> Result<Object<'js>, Value<'js>>

Try convert into returning self if the conversion fails

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

Convert from

impl<'js> Value<'js>

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 fn into_function(self) -> Option<Function<'js>>

Try convert into

pub fn try_into_function(self) -> Result<Function<'js>, Value<'js>>

Try convert into returning self if the conversion fails

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

Convert from

impl<'js> Value<'js>

pub unsafe fn ref_constructor(&self) -> &Constructor<'js>

Interprete as

Safety

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

pub fn as_constructor(&self) -> Option<&Constructor<'js>>

Try reinterprete as

pub fn into_constructor(self) -> Option<Constructor<'js>>

Try convert into

pub fn try_into_constructor(self) -> Result<Constructor<'js>, Value<'js>>

Try convert into returning self if the conversion fails

pub fn from_constructor(value: Constructor<'js>) -> Self

Convert from

impl<'js> Value<'js>

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 fn into_array(self) -> Option<Array<'js>>

Try convert into

pub fn try_into_array(self) -> Result<Array<'js>, Value<'js>>

Try convert into returning self if the conversion fails

pub fn from_array(value: Array<'js>) -> Self

Convert from

impl<'js> Value<'js>

pub unsafe fn ref_exception(&self) -> &Exception<'js>

Interprete as

Safety

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

pub fn as_exception(&self) -> Option<&Exception<'js>>

Try reinterprete as

pub fn into_exception(self) -> Option<Exception<'js>>

Try convert into

pub fn try_into_exception(self) -> Result<Exception<'js>, Value<'js>>

Try convert into returning self if the conversion fails

pub fn from_exception(value: Exception<'js>) -> Self

Convert from

impl<'js> Value<'js>

pub unsafe fn ref_big_int(&self) -> &BigInt<'js>

Interprete as

Safety

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

pub fn as_big_int(&self) -> Option<&BigInt<'js>>

Try reinterprete as

pub fn into_big_int(self) -> Option<BigInt<'js>>

Try convert into

pub fn try_into_big_int(self) -> Result<BigInt<'js>, Value<'js>>

Try convert into returning self if the conversion fails

pub fn from_big_int(value: BigInt<'js>) -> Self

Convert from

Trait Implementations

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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> AsRef<Value<'js>> for Object<'js>

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

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

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

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

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

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

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

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

impl<'js, T> AsRef<Value<'js>> for TypedArray<'js, T>

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

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

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

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

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

impl<'js> Clone for Value<'js>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'js> Debug for Value<'js>

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

Formats the value using the given formatter.

impl<'js> Drop for Value<'js>

fn drop(&mut self)

Executes the destructor for this type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl<'js> FromAtom<'js> for Value<'js>

fn from_atom(atom: Atom<'js>) -> Result<Self>

impl<'js> FromJs<'js> for Value<'js>

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

impl<'js> IntoAtom<'js> for Value<'js>

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

impl<'js> IntoJs<'js> for &Value<'js>

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

impl<'js> IntoJs<'js> for Value<'js>

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

impl<'js> Outlive<'js> for Value<'js>

type Target<'to> = Value<'to>

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

impl<'js> PartialEq<Value<'js>> for Value<'js>

fn eq(&self, other: &Self) -> 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> Trace<'js> for Value<'js>

fn trace<'a>(&self, tracer: Tracer<'a, 'js>)