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 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386
//! Map utils, these methods can be used to manage Map objects from rust
//! see [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map) for more on Maps
use crate::jsutils::JsError;
use crate::quickjs_utils::objects::{construct_object, is_instance_of_by_name};
use crate::quickjs_utils::{arrays, functions, get_constructor, iterators, objects, primitives};
use crate::quickjsrealmadapter::QuickJsRealmAdapter;
use crate::quickjsvalueadapter::QuickJsValueAdapter;
use libquickjs_sys as q;
/// create new instance of Map
/// # Example
/// ```rust
/// use quickjs_runtime::builder::QuickJsRuntimeBuilder;
/// use quickjs_runtime::quickjs_utils::maps::new_map_q;
/// use quickjs_runtime::quickjsvalueadapter::QuickJsValueAdapter;
///
/// let rt = QuickJsRuntimeBuilder::new().build();
/// rt.exe_rt_task_in_event_loop(|q_js_rt| {
/// let q_ctx = q_js_rt.get_main_realm();
/// let my_map: QuickJsValueAdapter = new_map_q(q_ctx).ok().unwrap();
/// });
/// ```
pub fn new_map_q(q_ctx: &QuickJsRealmAdapter) -> Result<QuickJsValueAdapter, JsError> {
unsafe { new_map(q_ctx.context) }
}
/// create new instance of Map
/// # Safety
/// please ensure the passed JSContext is still valid
pub unsafe fn new_map(ctx: *mut q::JSContext) -> Result<QuickJsValueAdapter, JsError> {
let map_constructor = get_constructor(ctx, "Map")?;
construct_object(ctx, &map_constructor, &[])
}
/// see if a JSValueRef is an instance of Map
pub fn is_map_q(q_ctx: &QuickJsRealmAdapter, obj: &QuickJsValueAdapter) -> Result<bool, JsError> {
unsafe { is_map(q_ctx.context, obj) }
}
/// see if a JSValueRef is an instance of Map
/// # Safety
/// please ensure the passed JSContext is still valid
pub unsafe fn is_map(ctx: *mut q::JSContext, obj: &QuickJsValueAdapter) -> Result<bool, JsError> {
is_instance_of_by_name(ctx, obj, "Map")
}
/// set a key/value pair in a Map
/// # Example
/// ```rust
/// use quickjs_runtime::builder::QuickJsRuntimeBuilder;
/// use quickjs_runtime::quickjs_utils::maps::{new_map_q, set_q};
/// use quickjs_runtime::quickjsvalueadapter::QuickJsValueAdapter;
/// use quickjs_runtime::quickjs_utils::primitives;
///
/// let rt = QuickJsRuntimeBuilder::new().build();
/// rt.exe_rt_task_in_event_loop(|q_js_rt| {
/// let q_ctx = q_js_rt.get_main_realm();
/// let my_map: QuickJsValueAdapter = new_map_q(q_ctx).ok().unwrap();
/// let key = primitives::from_i32(12);
/// let value = primitives::from_i32(23);
/// set_q(q_ctx, &my_map, key, value).ok().unwrap();
/// });
/// ```
pub fn set_q(
q_ctx: &QuickJsRealmAdapter,
map: &QuickJsValueAdapter,
key: QuickJsValueAdapter,
val: QuickJsValueAdapter,
) -> Result<QuickJsValueAdapter, JsError> {
unsafe { set(q_ctx.context, map, key, val) }
}
/// set a key/value pair in a Map
/// # Safety
/// please ensure the passed JSContext is still valid
pub unsafe fn set(
ctx: *mut q::JSContext,
map: &QuickJsValueAdapter,
key: QuickJsValueAdapter,
val: QuickJsValueAdapter,
) -> Result<QuickJsValueAdapter, JsError> {
functions::invoke_member_function(ctx, map, "set", &[key, val])
}
/// get a value from a map by key
/// # Example
/// ```rust
/// use quickjs_runtime::builder::QuickJsRuntimeBuilder;
/// use quickjs_runtime::quickjs_utils::maps::{new_map_q, get_q, set_q};
/// use quickjs_runtime::quickjsvalueadapter::QuickJsValueAdapter;
/// use quickjs_runtime::quickjs_utils::primitives;
///
/// let rt = QuickJsRuntimeBuilder::new().build();
/// rt.exe_rt_task_in_event_loop(|q_js_rt| {
/// let q_ctx = q_js_rt.get_main_realm();
/// let my_map: QuickJsValueAdapter = new_map_q(q_ctx).ok().unwrap();
/// let key = primitives::from_i32(12);
/// let value = primitives::from_i32(23);
/// set_q(q_ctx, &my_map, key.clone(), value).ok().unwrap();
/// let val_res = get_q(q_ctx, &my_map, key).ok().unwrap();
/// assert_eq!(primitives::to_i32(&val_res).ok().unwrap(), 23);
/// });
/// ```
pub fn get_q(
q_ctx: &QuickJsRealmAdapter,
map: &QuickJsValueAdapter,
key: QuickJsValueAdapter,
) -> Result<QuickJsValueAdapter, JsError> {
unsafe { get(q_ctx.context, map, key) }
}
/// get a value from a map by key
/// # Safety
/// please ensure the passed JSContext is still valid
pub unsafe fn get(
ctx: *mut q::JSContext,
map: &QuickJsValueAdapter,
key: QuickJsValueAdapter,
) -> Result<QuickJsValueAdapter, JsError> {
functions::invoke_member_function(ctx, map, "get", &[key])
}
/// delete a value from a map by key
/// # Example
/// ```rust
/// use quickjs_runtime::builder::QuickJsRuntimeBuilder;
/// use quickjs_runtime::quickjs_utils::maps::{new_map_q, set_q, delete_q};
/// use quickjs_runtime::quickjsvalueadapter::QuickJsValueAdapter;
/// use quickjs_runtime::quickjs_utils::primitives;
///
/// let rt = QuickJsRuntimeBuilder::new().build();
/// rt.exe_rt_task_in_event_loop(|q_js_rt| {
/// let q_ctx = q_js_rt.get_main_realm();
/// let my_map: QuickJsValueAdapter = new_map_q(q_ctx).ok().unwrap();
/// let key = primitives::from_i32(12);
/// let value = primitives::from_i32(23);
/// set_q(q_ctx, &my_map, key.clone(), value).ok().unwrap();
/// delete_q(q_ctx, &my_map, key).ok().unwrap();
/// });
/// ```
pub fn delete_q(
q_ctx: &QuickJsRealmAdapter,
map: &QuickJsValueAdapter,
key: QuickJsValueAdapter,
) -> Result<bool, JsError> {
unsafe { delete(q_ctx.context, map, key) }
}
/// delete a value from a map by key
/// # Safety
/// please ensure the passed JSContext is still valid
pub unsafe fn delete(
ctx: *mut q::JSContext,
map: &QuickJsValueAdapter,
key: QuickJsValueAdapter,
) -> Result<bool, JsError> {
let res = functions::invoke_member_function(ctx, map, "delete", &[key])?;
primitives::to_bool(&res)
}
/// check whether a Map has a value for a key
/// # Example
/// ```rust
/// use quickjs_runtime::builder::QuickJsRuntimeBuilder;
/// use quickjs_runtime::quickjs_utils::maps::{new_map_q, set_q, has_q};
/// use quickjs_runtime::quickjsvalueadapter::QuickJsValueAdapter;
/// use quickjs_runtime::quickjs_utils::primitives;
///
/// let rt = QuickJsRuntimeBuilder::new().build();
/// rt.exe_rt_task_in_event_loop(|q_js_rt| {
/// let q_ctx = q_js_rt.get_main_realm();
/// let my_map: QuickJsValueAdapter = new_map_q(q_ctx).ok().unwrap();
/// let key = primitives::from_i32(12);
/// let value = primitives::from_i32(23);
/// set_q(q_ctx, &my_map, key.clone(), value).ok().unwrap();
/// let bln_has = has_q(q_ctx, &my_map, key).ok().unwrap();
/// assert!(bln_has);
/// });
/// ```
pub fn has_q(
q_ctx: &QuickJsRealmAdapter,
map: &QuickJsValueAdapter,
key: QuickJsValueAdapter,
) -> Result<bool, JsError> {
unsafe { has(q_ctx.context, map, key) }
}
/// check whether a Map has a value for a key
/// # Safety
/// please ensure the passed JSContext is still valid
pub unsafe fn has(
ctx: *mut q::JSContext,
map: &QuickJsValueAdapter,
key: QuickJsValueAdapter,
) -> Result<bool, JsError> {
let res = functions::invoke_member_function(ctx, map, "has", &[key])?;
primitives::to_bool(&res)
}
/// get the number of entries in a map
/// # Example
/// ```rust
/// use quickjs_runtime::builder::QuickJsRuntimeBuilder;
/// use quickjs_runtime::quickjs_utils::maps::{new_map_q, set_q, size_q};
/// use quickjs_runtime::quickjsvalueadapter::QuickJsValueAdapter;
/// use quickjs_runtime::quickjs_utils::primitives;
///
/// let rt = QuickJsRuntimeBuilder::new().build();
/// rt.exe_rt_task_in_event_loop(|q_js_rt| {
/// let q_ctx = q_js_rt.get_main_realm();
/// let my_map: QuickJsValueAdapter = new_map_q(q_ctx).ok().unwrap();
/// let key = primitives::from_i32(12);
/// let value = primitives::from_i32(23);
/// set_q(q_ctx, &my_map, key.clone(), value).ok().unwrap();
/// let i_size = size_q(q_ctx, &my_map).ok().unwrap();
/// assert_eq!(i_size, 1);
/// });
/// ```
pub fn size_q(q_ctx: &QuickJsRealmAdapter, map: &QuickJsValueAdapter) -> Result<i32, JsError> {
unsafe { size(q_ctx.context, map) }
}
/// get the number of entries in a map
/// # Safety
/// please ensure the passed JSContext is still valid
pub unsafe fn size(ctx: *mut q::JSContext, map: &QuickJsValueAdapter) -> Result<i32, JsError> {
let res = objects::get_property(ctx, map, "size")?;
primitives::to_i32(&res)
}
/// remove all entries from a map
/// # Example
/// ```rust
/// use quickjs_runtime::builder::QuickJsRuntimeBuilder;
/// use quickjs_runtime::quickjs_utils::maps::{new_map_q, set_q, clear_q, size_q};
/// use quickjs_runtime::quickjsvalueadapter::QuickJsValueAdapter;
/// use quickjs_runtime::quickjs_utils::primitives;
///
/// let rt = QuickJsRuntimeBuilder::new().build();
/// rt.exe_rt_task_in_event_loop(|q_js_rt| {
/// let q_ctx = q_js_rt.get_main_realm();
/// let my_map: QuickJsValueAdapter = new_map_q(q_ctx).ok().unwrap();
/// let key = primitives::from_i32(12);
/// let value = primitives::from_i32(23);
/// set_q(q_ctx, &my_map, key.clone(), value).ok().unwrap();
/// clear_q(q_ctx, &my_map).ok().unwrap();
/// let i_size = size_q(q_ctx, &my_map).ok().unwrap();
/// assert_eq!(i_size, 0);
/// });
/// ```
pub fn clear_q(q_ctx: &QuickJsRealmAdapter, map: &QuickJsValueAdapter) -> Result<(), JsError> {
unsafe { clear(q_ctx.context, map) }
}
/// remove all entries from a map
/// # Safety
/// please ensure the passed JSContext is still valid
pub unsafe fn clear(ctx: *mut q::JSContext, map: &QuickJsValueAdapter) -> Result<(), JsError> {
let _ = functions::invoke_member_function(ctx, map, "clear", &[])?;
Ok(())
}
/// iterate over all keys of a map
/// # Example
/// ```rust
/// use quickjs_runtime::builder::QuickJsRuntimeBuilder;
/// use quickjs_runtime::quickjs_utils::maps::{new_map_q, set_q, keys_q};
/// use quickjs_runtime::quickjsvalueadapter::QuickJsValueAdapter;
/// use quickjs_runtime::quickjs_utils::primitives;
///
/// let rt = QuickJsRuntimeBuilder::new().build();
/// rt.exe_rt_task_in_event_loop(|q_js_rt| {
/// let q_ctx = q_js_rt.get_main_realm();
/// let my_map: QuickJsValueAdapter = new_map_q(q_ctx).ok().unwrap();
/// let key = primitives::from_i32(12);
/// let value = primitives::from_i32(23);
/// set_q(q_ctx, &my_map, key, value).ok().unwrap();
/// let mapped_keys = keys_q(q_ctx, &my_map, |key| {Ok(123)}).ok().unwrap();
/// assert_eq!(mapped_keys.len(), 1);
/// });
/// ```
pub fn keys_q<C: Fn(QuickJsValueAdapter) -> Result<R, JsError>, R>(
q_ctx: &QuickJsRealmAdapter,
map: &QuickJsValueAdapter,
consumer_producer: C,
) -> Result<Vec<R>, JsError> {
unsafe { keys(q_ctx.context, map, consumer_producer) }
}
/// iterate over all keys of a map
/// # Safety
/// please ensure the passed JSContext is still valid
pub unsafe fn keys<C: Fn(QuickJsValueAdapter) -> Result<R, JsError>, R>(
ctx: *mut q::JSContext,
map: &QuickJsValueAdapter,
consumer_producer: C,
) -> Result<Vec<R>, JsError> {
let iter_ref = functions::invoke_member_function(ctx, map, "keys", &[])?;
iterators::iterate(ctx, &iter_ref, consumer_producer)
}
/// iterate over all values of a map
/// # Example
/// ```rust
/// use quickjs_runtime::builder::QuickJsRuntimeBuilder;
/// use quickjs_runtime::quickjs_utils::maps::{new_map_q, set_q, values_q};
/// use quickjs_runtime::quickjsvalueadapter::QuickJsValueAdapter;
/// use quickjs_runtime::quickjs_utils::primitives;
///
/// let rt = QuickJsRuntimeBuilder::new().build();
/// rt.exe_rt_task_in_event_loop(|q_js_rt| {
/// let q_ctx = q_js_rt.get_main_realm();
/// let my_map: QuickJsValueAdapter = new_map_q(q_ctx).ok().unwrap();
/// let key = primitives::from_i32(12);
/// let value = primitives::from_i32(23);
/// set_q(q_ctx, &my_map, key, value).ok().unwrap();
/// let mapped_values = values_q(q_ctx, &my_map, |value| {Ok(123)}).ok().unwrap();
/// assert_eq!(mapped_values.len(), 1);
/// });
/// ```
pub fn values_q<C: Fn(QuickJsValueAdapter) -> Result<R, JsError>, R>(
q_ctx: &QuickJsRealmAdapter,
map: &QuickJsValueAdapter,
consumer_producer: C,
) -> Result<Vec<R>, JsError> {
unsafe { values(q_ctx.context, map, consumer_producer) }
}
/// iterate over all values of a map
/// # Safety
/// please ensure the passed JSContext is still valid
pub unsafe fn values<C: Fn(QuickJsValueAdapter) -> Result<R, JsError>, R>(
ctx: *mut q::JSContext,
map: &QuickJsValueAdapter,
consumer_producer: C,
) -> Result<Vec<R>, JsError> {
let iter_ref = functions::invoke_member_function(ctx, map, "values", &[])?;
iterators::iterate(ctx, &iter_ref, consumer_producer)
}
/// iterate over all entries of a map
/// # Example
/// ```rust
/// use quickjs_runtime::builder::QuickJsRuntimeBuilder;
/// use quickjs_runtime::quickjs_utils::maps::{new_map_q, set_q, entries_q};
/// use quickjs_runtime::quickjsvalueadapter::QuickJsValueAdapter;
/// use quickjs_runtime::quickjs_utils::primitives;
///
/// let rt = QuickJsRuntimeBuilder::new().build();
/// rt.exe_rt_task_in_event_loop(|q_js_rt| {
/// let q_ctx = q_js_rt.get_main_realm();
/// let my_map: QuickJsValueAdapter = new_map_q(q_ctx).ok().unwrap();
/// let key = primitives::from_i32(12);
/// let value = primitives::from_i32(23);
/// set_q(q_ctx, &my_map, key, value).ok().unwrap();
/// let mapped_values = entries_q(q_ctx, &my_map, |key, value| {Ok(123)}).ok().unwrap();
/// assert_eq!(mapped_values.len(), 1);
/// });
/// ```
pub fn entries_q<C: Fn(QuickJsValueAdapter, QuickJsValueAdapter) -> Result<R, JsError>, R>(
q_ctx: &QuickJsRealmAdapter,
map: &QuickJsValueAdapter,
consumer_producer: C,
) -> Result<Vec<R>, JsError> {
unsafe { entries(q_ctx.context, map, consumer_producer) }
}
/// iterate over all entries of a map
/// # Safety
/// please ensure the passed JSContext is still valid
pub unsafe fn entries<C: Fn(QuickJsValueAdapter, QuickJsValueAdapter) -> Result<R, JsError>, R>(
ctx: *mut q::JSContext,
map: &QuickJsValueAdapter,
consumer_producer: C,
) -> Result<Vec<R>, JsError> {
let iter_ref = functions::invoke_member_function(ctx, map, "entries", &[])?;
iterators::iterate(ctx, &iter_ref, |arr_ref| {
let key = arrays::get_element(ctx, &arr_ref, 0)?;
let value = arrays::get_element(ctx, &arr_ref, 1)?;
consumer_producer(key, value)
})
}