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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
use std::ops::Deref;
use rust_jsc_sys::{JSObjectMakeArray, JSValueRef};
use crate::{JSArray, JSContext, JSError, JSObject, JSResult, JSValue};
impl JSArray {
pub fn new(object: JSObject) -> Self {
Self { object }
}
/// Creates a new `JSArray` object.
///
/// # Arguments
/// - `ctx`: The JavaScript context to create the array in.
/// - `args`: The values to initialize the array with.
///
/// # Example
/// ```
/// use rust_jsc::{JSArray, JSContext, JSValue};
///
/// let ctx = JSContext::new();
/// let array = JSArray::new_array(
/// &ctx,
/// &[
/// JSValue::number(&ctx, 1.0),
/// JSValue::number(&ctx, 2.0),
/// JSValue::number(&ctx, 3.0),
/// ]
/// ).unwrap();
/// assert_eq!(array.as_string().unwrap(), "1,2,3");
/// ```
///
/// # Errors
/// If an exception is thrown while creating the array.
/// A `JSError` will be returned.
///
/// # Returns
/// The new `JSArray` object.
pub fn new_array(ctx: &JSContext, args: &[JSValue]) -> JSResult<Self> {
let mut exception: JSValueRef = std::ptr::null_mut();
let args: Vec<JSValueRef> = args.iter().map(|arg| arg.inner).collect();
let result = unsafe {
JSObjectMakeArray(ctx.inner, args.len(), args.as_ptr(), &mut exception)
};
if !exception.is_null() {
let value = JSValue::new(exception, ctx.inner);
return Err(JSError::from(value));
}
Ok(Self::new(JSObject::from_ref(result, ctx.inner)))
}
/// Gets the value at the specified index.
/// This is equivalent to `array[index]` in JavaScript.
///
/// # Arguments
/// - `index`: The index of the value to get.
///
/// # Example
/// ```
/// use rust_jsc::{JSArray, JSContext, JSValue};
///
/// let ctx = JSContext::new();
/// let array = JSArray::new_array(
/// &ctx,
/// &[
/// JSValue::number(&ctx, 1.0),
/// JSValue::number(&ctx, 2.0),
/// JSValue::number(&ctx, 3.0),
/// ]
/// ).unwrap();
/// assert_eq!(array.get(0).unwrap().as_number().unwrap(), 1.0);
/// ```
///
/// # Errors
/// If an exception is thrown while getting the value.
/// A `JSError` will be returned.
///
/// # Returns
/// The value at the specified index.
pub fn get(&self, index: u32) -> JSResult<JSValue> {
self.object.get_property_at_index(index)
}
/// Sets the value at the specified index.
/// This is equivalent to `array[index] = value` in JavaScript.
///
/// # Arguments
/// - `index`: The index of the value to set.
/// - `value`: The value to set.
///
/// # Example
/// ```
/// use rust_jsc::{JSArray, JSContext, JSValue};
///
/// let ctx = JSContext::new();
/// let array = JSArray::new_array(
/// &ctx,
/// &[
/// JSValue::number(&ctx, 1.0),
/// JSValue::number(&ctx, 2.0),
/// JSValue::number(&ctx, 3.0),
/// ]
/// ).unwrap();
/// array.set(0, &JSValue::number(&ctx, 4.0)).unwrap();
/// array.set(1, &JSValue::number(&ctx, 5.0)).unwrap();
/// array.set(2, &JSValue::number(&ctx, 6.0)).unwrap();
/// assert_eq!(array.as_string().unwrap(), "4,5,6");
/// ```
///
/// # Errors
/// If an exception is thrown while setting the value.
/// A `JSError` will be returned.
///
/// # Returns
/// An empty `JSResult`.
pub fn set(&self, index: u32, value: &JSValue) -> JSResult<()> {
self.object.set_property_at_index(index, value)
}
/// Gets the length of the array.
/// This is equivalent to `array.length` in JavaScript.
///
/// # Example
/// ```
/// use rust_jsc::{JSArray, JSContext, JSValue};
///
/// let ctx = JSContext::new();
/// let array = JSArray::new_array(
/// &ctx,
/// &[
/// JSValue::number(&ctx, 1.0),
/// JSValue::number(&ctx, 2.0),
/// JSValue::number(&ctx, 3.0),
/// ]
/// ).unwrap();
/// assert_eq!(array.length().unwrap(), 3.0);
/// ```
///
/// # Errors
/// If an exception is thrown while getting the length.
/// A `JSError` will be returned.
///
/// # Returns
/// The length of the array.
pub fn length(&self) -> JSResult<f64> {
self.object.get_property("length")?.as_number()
}
/// Pushes a value to the end of the array.
/// This is equivalent to `array.push(value)` in JavaScript.
/// Returns the new length of the array.
///
/// # Arguments
/// - `value`: The value to push.
///
/// # Example
/// ```
/// use rust_jsc::{JSArray, JSContext, JSValue};
///
/// let ctx = JSContext::new();
/// let array = JSArray::new_array(
/// &ctx,
/// &[
/// JSValue::number(&ctx, 1.0),
/// JSValue::number(&ctx, 2.0),
/// JSValue::number(&ctx, 3.0),
/// ]
/// ).unwrap();
/// array.push(&JSValue::number(&ctx, 4 as f64)).unwrap();
/// array.push(&JSValue::number(&ctx, 5 as f64)).unwrap();
/// array.push(&JSValue::number(&ctx, 6 as f64)).unwrap();
/// assert_eq!(array.as_string().unwrap(), "1,2,3,4,5,6");
/// ```
///
/// # Errors
/// If an exception is thrown while pushing the value.
/// A `JSError` will be returned.
///
/// # Returns
/// The new length of the array.
pub fn push(&self, value: &JSValue) -> JSResult<f64> {
let length = self.length()?;
self.set(length as u32, value)?;
Ok(length + 1.0)
}
}
impl Deref for JSArray {
type Target = JSValue;
fn deref(&self) -> &JSValue {
&self.object
}
}
impl From<JSArray> for JSObject {
fn from(array: JSArray) -> Self {
array.object
}
}
impl From<JSArray> for JSValue {
fn from(array: JSArray) -> Self {
array.object.into()
}
}
#[cfg(test)]
mod tests {
use crate::{JSArray, JSContext, JSValue};
#[test]
fn test_array() {
let ctx = JSContext::new();
let array = JSArray::new_array(
&ctx,
&[
JSValue::number(&ctx, 1.0),
JSValue::number(&ctx, 2.0),
JSValue::number(&ctx, 3.0),
],
)
.unwrap();
assert_eq!(array.as_string().unwrap(), "1,2,3");
}
#[test]
fn test_array_get() {
let ctx = JSContext::new();
let array = JSArray::new_array(
&ctx,
&[
JSValue::number(&ctx, 1.0),
JSValue::number(&ctx, 2.0),
JSValue::number(&ctx, 3.0),
],
)
.unwrap();
assert_eq!(array.get(0).unwrap().as_number().unwrap(), 1.0);
assert_eq!(array.get(1).unwrap().as_number().unwrap(), 2.0);
assert_eq!(array.get(2).unwrap().as_number().unwrap(), 3.0);
}
#[test]
fn test_array_set() {
let ctx = JSContext::new();
let array = JSArray::new_array(
&ctx,
&[
JSValue::number(&ctx, 1.0),
JSValue::number(&ctx, 2.0),
JSValue::number(&ctx, 3.0),
],
)
.unwrap();
array.set(0, &JSValue::number(&ctx, 4.0)).unwrap();
array.set(1, &JSValue::number(&ctx, 5.0)).unwrap();
array.set(2, &JSValue::number(&ctx, 6.0)).unwrap();
assert_eq!(array.as_string().unwrap(), "4,5,6");
}
#[test]
fn test_array_length() {
let ctx = JSContext::new();
let array = JSArray::new_array(
&ctx,
&[
JSValue::number(&ctx, 1.0),
JSValue::number(&ctx, 2.0),
JSValue::number(&ctx, 3.0),
],
)
.unwrap();
assert_eq!(array.length().unwrap(), 3.0);
}
#[test]
fn test_array_push() {
let ctx = JSContext::new();
let array = JSArray::new_array(
&ctx,
&[
JSValue::number(&ctx, 1.0),
JSValue::number(&ctx, 2.0),
JSValue::number(&ctx, 3.0),
],
)
.unwrap();
array.push(&JSValue::number(&ctx, 4 as f64)).unwrap();
array.push(&JSValue::number(&ctx, 5 as f64)).unwrap();
array.push(&JSValue::number(&ctx, 6 as f64)).unwrap();
assert_eq!(array.as_string().unwrap(), "1,2,3,4,5,6");
}
}