Crate rquickjs_core

High-level bindings to quickjs

The rquickjs crate provides safe high-level bindings to the quickjs javascript engine. This crate is heavily inspired by the rlua crate.

Modules

intrinsic	A marker types for intrinsic
qjs	Native low-level bindings

Macros

class_def	classes The macro to simplify class definition.
generic_loader	loader The helper macro to impl Loader traits for generic module kind.
module_init	Helper macro to provide module init function

Structs

Accessor	properties The accessor descriptor of a readonly property
Array	Rust representation of a javascript object optimized as an array.
Async	futures The wrapper for async functons
AsyncStd	async-std The async_std runtime for spawning executors.
Atom	An atom is value representing the name of a variable of an objects and can be created from any javascript value.
BuiltinLoader	loader The builtin script module loader
BuiltinResolver	loader The builtin module resolver
Bundle	The resolver and loader for bundles of compiled modules
Class	classes The class object interface
ClassId	classes The type of identifier of class
Coerced	The wrapper for values to force coercion
Compile	loader Modules compiling data
Constructor	classes The wrapper for constructor function
Context	A single execution context with its own global variables and stack.
ContextBuilder	Used for building a Context with a specific set of intrinsics
Created	The marker for the module which is created but not loaded yet
Ctx	Context in use, passed to Context::with.
Evaluated	The marker for the module which is already loaded and evaluated
Executor	futures The async executor future
ExportEntriesIter	exports An iterator over the items exported out a module
ExportNamesIter	exports An iterator over the items exported out a module
FileResolver	loader The file module resolver
Filter	The property filter
Func	The wrapper for function to convert is into JS
Function	Rust representation of a javascript function.
Idle	The idle awaiting future
Loaded	The marker for the module which is loaded but not evaluated yet
MemoryUsage
Method	The wrapper for method functions
Module	Javascript module with certain exports and imports
ModuleLoader	loader The builtin native module loader
MutFn	The wrapper for mutable functions
Native	The marker for the module which is created using ModuleDef
NativeLoader	dyn-load The native module loader
Null	The placeholder which treated as null value
Object	Rust representation of a javascript object.
OnceFn	The wrapper for once functions
Opt	The wrapper to get optional argument from input
Persistent	The wrapper for JS values to keep it from GC
Promise	futures Future-aware promise
Promised	futures Wrapper for futures to convert to JS promises
Property	properties The data descriptor of a property
RefsMarker	classes The helper for QuickJS garbage collector which helps it find internal JS object references.
RegisteryKey	registery Key for a registery of a context.
Rest	The wrapper the rest arguments from input
Runtime	Quickjs runtime, entry point of the library.
RustAllocator	The allocator which uses Rust global allocator
Script	The marker for the module which is created from text source
ScriptLoader	loader The script module loader
String	Rust representation of a javascript string.
Symbol	Rust representation of a javascript symbol.
This	The wrapper to get this from input
Tokio	tokio The tokio async runtime for spawning executors.
Undefined	The placeholder which treated as undefined value
Uninitialized	The placeholder which treated as uninitialized JS value
Value	Any javascript value
WithProto	classes The prototype setting wrapper

Enums

Error	Error type of the library.
Type	The type of value

Traits

Allocator	allocator The allocator interface
AsArguments	A helper trait to pass arguments on a function calls.
AsFunction	The trait to wrap rust function to JS directly
AsProperty	properties The property interface
ClassDef	classes The ES6 class definition trait
ExecutorSpawner	futures The trait to spawn execution of pending jobs on async runtime
FromAtom	Trait for converting values from atoms.
FromIteratorJs	The Rust's FromIterator trait to use with Ctx
FromJs	For converting javascript values to rust values
HasByteCode	The module data which contains bytecode
HasRefs	classes The helper trait to mark internal JS value refs
IntoAtom	Trait for converting values to atoms.
IntoJs	For converting rust values to javascript values
Intrinsic	The internal trait to add JS builting
IteratorJs	The Rust's Iterator trait extension which works with Ctx
Loader	loader Module loader interface
ModuleDef	Module definition trait
MultiWith	A trait for using multiple contexts at the same time.
ObjectDef	The helper trait to define objects
Outlive	The trait to help break lifetime rules when JS objects leaves current context via Persistent wrapper.
ParallelSend	The marker trait which requires Send when "parallel" feature is used
Resolver	loader Module resolver interface

Type Definitions

ModuleLoadFn	The raw module load function (js_module_init)
RawMemPtr	allocator Raw memory pointer
Result	Result type used throught the library.