Struct boa::Context

pub struct Context { /* fields omitted */ }

Javascript context. It is the primary way to interact with the runtime.

For each Context instance a new instance of runtime is created. It means that it is safe to use different contexts in different threads, but each Context instance must be used only from a single thread.

Implementations

impl Context

pub fn new() -> Self

Create a new Context.

pub fn realm(&self) -> &Realm

pub fn realm_mut(&mut self) -> &mut Realm

pub fn executor(&mut self) -> &mut Interpreter

pub fn construct_symbol(&mut self, description: Option<RcString>) -> RcSymbol

Construct a new Symbol with an optional description.

pub fn construct_object(&self) -> GcObject

Construct an empty object.

pub fn global_object(&self) -> &Value

Return the global object.

pub fn construct_range_error<M>(&mut self, message: M) -> Value where
    M: Into<String>, 

Constructs a RangeError with the specified message.

pub fn throw_range_error<M>(&mut self, message: M) -> Result<Value> where
    M: Into<String>, 

Throws a RangeError with the specified message.

pub fn construct_type_error<M>(&mut self, message: M) -> Value where
    M: Into<String>, 

Constructs a TypeError with the specified message.

pub fn throw_type_error<M>(&mut self, message: M) -> Result<Value> where
    M: Into<String>, 

Throws a TypeError with the specified message.

pub fn construct_reference_error<M>(&mut self, message: M) -> Value where
    M: Into<String>, 

Constructs a ReferenceError with the specified message.

pub fn throw_reference_error<M>(&mut self, message: M) -> Result<Value> where
    M: Into<String>, 

Throws a ReferenceError with the specified message.

pub fn construct_syntax_error<M>(&mut self, message: M) -> Value where
    M: Into<String>, 

Constructs a SyntaxError with the specified message.

pub fn throw_syntax_error<M>(&mut self, message: M) -> Result<Value> where
    M: Into<String>, 

Throws a SyntaxError with the specified message.

pub fn create_builtin_function(
    &mut self,
    name: &str,
    length: usize,
    body: NativeFunction
) -> Result<GcObject>

Create a new builin function.

pub fn register_global_function(
    &mut self,
    name: &str,
    length: usize,
    body: NativeFunction
) -> Result<()>

Register a global function.

pub fn register_global_class<T>(&mut self) -> Result<()> where
    T: Class, 

Register a global class of type T, where T implemets Class.

Example

#[derive(Debug, Trace, Finalize)]
struct MyClass;

impl Class for MyClass {
   // ...
}

context.register_global_class::<MyClass>();

pub fn eval(&mut self, src: &str) -> Result<Value>

Evaluates the given code.

Examples

let mut context = Context::new();

let value = context.eval("1 + 3").unwrap();

assert!(value.is_number());
assert_eq!(value.as_number().unwrap(), 4.0);

pub fn well_known_symbols(&self) -> &WellKnownSymbols

Returns a structure that contains the JavaScript well known symbols.

Examples

let mut context = Context::new();

let iterator = context.well_known_symbols().iterator_symbol();
assert_eq!(iterator.description(), Some("Symbol.iterator"));

This is equivalent to let iterator = Symbol.iterator in JavaScript.

Trait Implementations

impl Debug for Context

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

Formats the value using the given formatter.

impl Default for Context

fn default() -> Self

Returns the "default value" for a type.