boa_engine 0.17.0

Boa is a Javascript lexer, parser and compiler written in Rust. Currently, it has support for some of the language.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

//! A Rust API wrapper for Boa's `Generator` Builtin ECMAScript Object
use crate::{
    builtins::generator::Generator,
    object::{JsObject, JsObjectType},
    value::TryFromJs,
    Context, JsNativeError, JsResult, JsValue,
};

use boa_gc::{Finalize, Trace};
use std::ops::Deref;

/// `JsGenerator` provides a wrapper for Boa's implementation of the ECMAScript `Generator` builtin object
#[derive(Debug, Clone, Trace, Finalize)]
pub struct JsGenerator {
    inner: JsObject,
}

impl JsGenerator {
    /// Creates a `JsGenerator` from a generator `JsObject`
    #[inline]
    pub fn from_object(object: JsObject) -> JsResult<Self> {
        if object.is_generator() {
            Ok(Self { inner: object })
        } else {
            Err(JsNativeError::typ()
                .with_message("object is not a Generator")
                .into())
        }
    }

    /// Calls `Generator.prototype.next()`
    ///
    /// This method returns an object with the properties `done` and `value`
    pub fn next<T>(&self, value: T, context: &mut Context<'_>) -> JsResult<JsValue>
    where
        T: Into<JsValue>,
    {
        Generator::next(&self.inner.clone().into(), &[value.into()], context)
    }

    /// Calls `Generator.prototype.return()`
    ///
    /// This method returns the given value and finishes the generator
    pub fn r#return<T>(&self, value: T, context: &mut Context<'_>) -> JsResult<JsValue>
    where
        T: Into<JsValue>,
    {
        Generator::r#return(&self.inner.clone().into(), &[value.into()], context)
    }

    /// Calls `Generator.prototype.throw()`
    ///
    /// This method resumes the execution of a generator by throwing an error and returning an
    /// an object with the properties `done` and `value`
    pub fn throw<T>(&self, value: T, context: &mut Context<'_>) -> JsResult<JsValue>
    where
        T: Into<JsValue>,
    {
        Generator::throw(&self.inner.clone().into(), &[value.into()], context)
    }
}

impl From<JsGenerator> for JsObject {
    #[inline]
    fn from(o: JsGenerator) -> Self {
        o.inner.clone()
    }
}

impl From<JsGenerator> for JsValue {
    #[inline]
    fn from(o: JsGenerator) -> Self {
        o.inner.clone().into()
    }
}

impl Deref for JsGenerator {
    type Target = JsObject;

    #[inline]
    fn deref(&self) -> &Self::Target {
        &self.inner
    }
}

impl JsObjectType for JsGenerator {}

impl TryFromJs for JsGenerator {
    fn try_from_js(value: &JsValue, _context: &mut Context<'_>) -> JsResult<Self> {
        match value {
            JsValue::Object(o) => Self::from_object(o.clone()),
            _ => Err(JsNativeError::typ()
                .with_message("value is not a Generator object")
                .into()),
        }
    }
}