Struct rquickjs::Atom

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

A QuickJS Atom.

In QuickJS atoms are similar to interned string but with additional uses. A symbol for instance is just an atom.

Representation

Atoms in QuickJS are handled differently depending on what type of index the represent. When the atom represents a number like index, like object[1] the atom is just a normal number. However when the atom represents a string link index like object["foo"] or object.foo the atom represents a value in a hashmap.

Implementations

impl<'js> Atom<'js>

pub fn from_value(ctx: Ctx<'js>, val: &Value<'js>) -> Result<Atom<'js>, Error>

Create an atom from a JavaScript value.

pub fn from_u32(ctx: Ctx<'js>, val: u32) -> Result<Atom<'js>, Error>

Create an atom from a u32

pub fn from_i32(ctx: Ctx<'js>, val: i32) -> Result<Atom<'js>, Error>

Create an atom from an i32 via value

pub fn from_bool(ctx: Ctx<'js>, val: bool) -> Result<Atom<'js>, Error>

Create an atom from a bool via value

pub fn from_f64(ctx: Ctx<'js>, val: f64) -> Result<Atom<'js>, Error>

Create an atom from a f64 via value

pub fn from_str(ctx: Ctx<'js>, name: &str) -> Result<Atom<'js>, Error>

Create an atom from a Rust string

pub fn from_predefined(ctx: Ctx<'js>, predefined: PredefinedAtom) -> Atom<'js>

Create an atom from a predefined atom.

pub fn to_string(&self) -> Result<String, Error>

Convert the atom to a JavaScript string.

pub fn to_js_string(&self) -> Result<String<'js>, Error>

Convert the atom to a JavaScript string.

pub fn to_value(&self) -> Result<Value<'js>, Error>

Convert the atom to a JavaScript value.

Trait Implementations

impl<'js> Clone for Atom<'js>

fn clone(&self) -> Atom<'js>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'js> Debug for Atom<'js>

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

Formats the value using the given formatter.

impl<'js> Drop for Atom<'js>

fn drop(&mut self)

Executes the destructor for this type.

impl<'js> FromAtom<'js> for Atom<'js>

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

impl<'js> Hash for Atom<'js>

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'js> IntoAtom<'js> for Atom<'js>

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

impl<'js> Outlive<'js> for Atom<'js>

type Target<'to> = Atom<'to>

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

impl<'js> PartialEq for Atom<'js>

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

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

impl<'js> Eq for Atom<'js>