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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
//! A Rust API wrapper for the `Set` Builtin ECMAScript Object
use std::ops::Deref;
use boa_gc::{Finalize, Trace};
use crate::{
builtins::Set,
error::JsNativeError,
object::{JsFunction, JsObject, JsObjectType, JsSetIterator},
value::TryFromJs,
Context, JsResult, JsValue,
};
/// `JsSet` provides a wrapper for Boa's implementation of the ECMAScript `Set` object.
#[derive(Debug, Clone, Trace, Finalize)]
pub struct JsSet {
inner: JsObject,
}
impl JsSet {
/// Create a new empty set.
///
/// Doesn't matches JavaScript `new Set()` as it doesn't takes an iterator
/// similar to Rust initialization.
#[inline]
pub fn new(context: &mut Context<'_>) -> Self {
let inner = Set::set_create(None, context);
Self { inner }
}
/// Returns the size of the `Set` as an integer.
///
/// Same as JavaScript's `set.size`.
#[inline]
pub fn size(&self) -> JsResult<usize> {
Set::get_size(&self.inner.clone().into())
}
/// Appends value to the Set object.
/// Returns the Set object with added value.
///
/// Same as JavaScript's `set.add(value)`.
pub fn add<T>(&self, value: T, context: &mut Context<'_>) -> JsResult<JsValue>
where
T: Into<JsValue>,
{
self.add_items(&[value.into()], context)
}
/// Adds slice as a single element.
/// Returns the Set object with added slice.
///
/// Same as JavaScript's `set.add(["one", "two", "three"])`
#[inline]
pub fn add_items(&self, items: &[JsValue], context: &mut Context<'_>) -> JsResult<JsValue> {
Set::add(&self.inner.clone().into(), items, context)
}
/// Removes all elements from the Set object.
/// Returns `Undefined`.
///
/// Same as JavaScript's `set.clear()`.
#[inline]
pub fn clear(&self, context: &mut Context<'_>) -> JsResult<JsValue> {
Set::clear(&self.inner.clone().into(), &[JsValue::Null], context)
}
/// Removes the element associated to the value.
/// Returns a boolean asserting whether an element was
/// successfully removed or not.
///
/// Same as JavaScript's `set.delete(value)`.
pub fn delete<T>(&self, value: T, context: &mut Context<'_>) -> JsResult<bool>
where
T: Into<JsValue>,
{
// TODO: Make `delete` return a native `bool`
match Set::delete(&self.inner.clone().into(), &[value.into()], context)? {
JsValue::Boolean(bool) => Ok(bool),
_ => unreachable!("`delete` must always return a bool"),
}
}
/// Returns a boolean asserting whether an element is present
/// with the given value in the Set object or not.
///
/// Same as JavaScript's `set.has(value)`.
pub fn has<T>(&self, value: T, context: &mut Context<'_>) -> JsResult<bool>
where
T: Into<JsValue>,
{
// TODO: Make `has` return a native `bool`
match Set::has(&self.inner.clone().into(), &[value.into()], context)? {
JsValue::Boolean(bool) => Ok(bool),
_ => unreachable!("`has` must always return a bool"),
}
}
/// Returns a new iterator object that yields the values
/// for each element in the Set object in insertion order.
///
/// Same as JavaScript's `set.values()`.
#[inline]
pub fn values(&self, context: &mut Context<'_>) -> JsResult<JsSetIterator> {
let iterator_object = Set::values(&self.inner.clone().into(), &[JsValue::Null], context)?
.get_iterator(context, None, None)?;
JsSetIterator::from_object(iterator_object.iterator().clone())
}
/// Alias for `Set.prototype.values()`
/// Returns a new iterator object that yields the values
/// for each element in the Set object in insertion order.
///
/// Same as JavaScript's `set.keys()`.
#[inline]
pub fn keys(&self, context: &mut Context<'_>) -> JsResult<JsSetIterator> {
let iterator_object = Set::values(&self.inner.clone().into(), &[JsValue::Null], context)?
.get_iterator(context, None, None)?;
JsSetIterator::from_object(iterator_object.iterator().clone())
}
/// Calls callbackFn once for each value present in the Set object,
/// in insertion order.
/// Returns `Undefined`.
///
/// Same as JavaScript's `set.forEach(values)`.
#[inline]
pub fn for_each(
&self,
callback: JsFunction,
this_arg: JsValue,
context: &mut Context<'_>,
) -> JsResult<JsValue> {
Set::for_each(
&self.inner.clone().into(),
&[callback.into(), this_arg],
context,
)
}
/// Utility: Creates `JsSet` from `JsObject`, if not a Set throw `TypeError`.
#[inline]
pub fn from_object(object: JsObject) -> JsResult<Self> {
if object.is_set() {
Ok(Self { inner: object })
} else {
Err(JsNativeError::typ()
.with_message("Object is not a Set")
.into())
}
}
/// Utility: Creates a `JsSet` from a `<IntoIterator<Item = JsValue>` convertible object.
pub fn from_iter<I>(elements: I, context: &mut Context<'_>) -> Self
where
I: IntoIterator<Item = JsValue>,
{
let inner = Set::create_set_from_list(elements, context);
Self { inner }
}
}
impl From<JsSet> for JsObject {
#[inline]
fn from(o: JsSet) -> Self {
o.inner.clone()
}
}
impl From<JsSet> for JsValue {
#[inline]
fn from(o: JsSet) -> Self {
o.inner.clone().into()
}
}
impl Deref for JsSet {
type Target = JsObject;
#[inline]
fn deref(&self) -> &Self::Target {
&self.inner
}
}
impl JsObjectType for JsSet {}
impl TryFromJs for JsSet {
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 Set object")
.into()),
}
}
}