rust-lodash 0.1.0

A high-performance, type-safe Rust implementation of Lodash collection methods with zero-cost abstractions
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
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
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
/*!

Async support for collection methods.

This module provides async versions of all collection methods, enabling
non-blocking operations on large datasets.
*/

#[cfg(feature = "async")]
use futures::future::{join_all, Future};
#[cfg(feature = "async")]
use crate::collection::Collection;
#[cfg(feature = "async")]
use crate::utils::{LodashError, Result, AsyncPredicate, AsyncMapper, AsyncReducer};

#[cfg(feature = "async")]
/// Async version of `map`.
/// 
/// # Examples
/// 
/// ```
/// use rust_lodash::collection::async_support::map_async;
/// 
/// # async fn example() {
/// let numbers = vec![1, 2, 3, 4, 5];
/// let doubled = map_async(&numbers, |x| async move { x * 2 }).await;
/// assert_eq!(doubled, vec![2, 4, 6, 8, 10]);
/// # }
/// ```
pub async fn map_async<T, U, F, Fut>(collection: &[T], iteratee: F) -> Vec<U>
where
    F: Fn(&T) -> Fut,
    Fut: Future<Output = U>,
{
    let futures = collection.iter().map(|item| iteratee(item));
    join_all(futures).await
}

#[cfg(feature = "async")]
/// Async version of `filter`.
/// 
/// # Examples
/// 
/// ```
/// use rust_lodash::collection::async_support::filter_async;
/// 
/// # async fn example() {
/// let numbers = vec![1, 2, 3, 4, 5];
/// let evens = filter_async(&numbers, |x| async move { x % 2 == 0 }).await;
/// assert_eq!(evens, vec![2, 4]);
/// # }
/// ```
pub async fn filter_async<T, F, Fut>(collection: &[T], predicate: F) -> Vec<T>
where
    T: Clone,
    F: Fn(&T) -> Fut,
    Fut: Future<Output = bool>,
{
    let mut results = Vec::new();
    let futures = collection.iter().map(|item| (item, predicate(item)));
    let predicate_results = join_all(futures.map(|(item, fut)| async move { (item, fut.await) })).await;
    
    for (item, should_include) in predicate_results {
        if should_include {
            results.push(item.clone());
        }
    }
    
    results
}

#[cfg(feature = "async")]
/// Async version of `reduce`.
/// 
/// # Examples
/// 
/// ```
/// use rust_lodash::collection::async_support::reduce_async;
/// 
/// # async fn example() {
/// let numbers = vec![1, 2, 3, 4, 5];
/// let sum = reduce_async(&numbers, |acc, x| async move { acc + x }, 0).await;
/// assert_eq!(sum, 15);
/// # }
/// ```
pub async fn reduce_async<T, U, F, Fut>(collection: &[T], iteratee: F, initial: U) -> U
where
    F: Fn(U, &T) -> Fut,
    Fut: Future<Output = U>,
{
    let mut acc = initial;
    for item in collection {
        acc = iteratee(acc, item).await;
    }
    acc
}

#[cfg(feature = "async")]
/// Async version of `for_each`.
/// 
/// # Examples
/// 
/// ```
/// use rust_lodash::collection::async_support::for_each_async;
/// 
/// # async fn example() {
/// let numbers = vec![1, 2, 3, 4, 5];
/// let mut sum = 0;
/// for_each_async(&numbers, |x| async move { sum += x }).await;
/// assert_eq!(sum, 15);
/// # }
/// ```
pub async fn for_each_async<T, F, Fut>(collection: &[T], iteratee: F)
where
    F: Fn(&T) -> Fut,
    Fut: Future<Output = ()>,
{
    let futures = collection.iter().map(|item| iteratee(item));
    join_all(futures).await;
}

#[cfg(feature = "async")]
/// Async version of `find`.
/// 
/// # Examples
/// 
/// ```
/// use rust_lodash::collection::async_support::find_async;
/// 
/// # async fn example() {
/// let numbers = vec![1, 2, 3, 4, 5];
/// let first_even = find_async(&numbers, |x| async move { x % 2 == 0 }).await;
/// assert_eq!(first_even, Some(&2));
/// # }
/// ```
pub async fn find_async<T, F, Fut>(collection: &[T], predicate: F) -> Option<&T>
where
    F: Fn(&T) -> Fut,
    Fut: Future<Output = bool>,
{
    for item in collection {
        if predicate(item).await {
            return Some(item);
        }
    }
    None
}

#[cfg(feature = "async")]
/// Async version of `every`.
/// 
/// # Examples
/// 
/// ```
/// use rust_lodash::collection::async_support::every_async;
/// 
/// # async fn example() {
/// let numbers = vec![2, 4, 6, 8];
/// let all_even = every_async(&numbers, |x| async move { x % 2 == 0 }).await;
/// assert!(all_even);
/// # }
/// ```
pub async fn every_async<T, F, Fut>(collection: &[T], predicate: F) -> bool
where
    F: Fn(&T) -> Fut,
    Fut: Future<Output = bool>,
{
    for item in collection {
        if !predicate(item).await {
            return false;
        }
    }
    true
}

#[cfg(feature = "async")]
/// Async version of `some`.
/// 
/// # Examples
/// 
/// ```
/// use rust_lodash::collection::async_support::some_async;
/// 
/// # async fn example() {
/// let numbers = vec![1, 3, 5, 7];
/// let has_even = some_async(&numbers, |x| async move { x % 2 == 0 }).await;
/// assert!(!has_even);
/// # }
/// ```
pub async fn some_async<T, F, Fut>(collection: &[T], predicate: F) -> bool
where
    F: Fn(&T) -> Fut,
    Fut: Future<Output = bool>,
{
    for item in collection {
        if predicate(item).await {
            return true;
        }
    }
    false
}

#[cfg(feature = "async")]
/// Collection methods that work on the `Collection` type.
impl<T> Collection<T> {
    /// Async version of `map`.
    /// 
    /// # Examples
    /// 
    /// ```
    /// use rust_lodash::collection::Collection;
    /// 
    /// # async fn example() {
    /// let collection = Collection::new(vec![1, 2, 3, 4, 5]);
    /// let doubled = collection.map_async(|x| async move { x * 2 }).await;
    /// assert_eq!(doubled, vec![2, 4, 6, 8, 10]);
    /// # }
    /// ```
    pub async fn map_async<U, F, Fut>(&self, iteratee: F) -> Vec<U>
    where
        F: Fn(&T) -> Fut,
        Fut: Future<Output = U>,
    {
        map_async(&self.data, iteratee).await
    }

    /// Async version of `filter`.
    /// 
    /// # Examples
    /// 
    /// ```
    /// use rust_lodash::collection::Collection;
    /// 
    /// # async fn example() {
    /// let collection = Collection::new(vec![1, 2, 3, 4, 5]);
    /// let evens = collection.filter_async(|x| async move { x % 2 == 0 }).await;
    /// assert_eq!(evens, vec![2, 4]);
    /// # }
    /// ```
    pub async fn filter_async<F, Fut>(&self, predicate: F) -> Vec<T>
    where
        T: Clone,
        F: Fn(&T) -> Fut,
        Fut: Future<Output = bool>,
    {
        filter_async(&self.data, predicate).await
    }

    /// Async version of `reduce`.
    /// 
    /// # Examples
    /// 
    /// ```
    /// use rust_lodash::collection::Collection;
    /// 
    /// # async fn example() {
    /// let collection = Collection::new(vec![1, 2, 3, 4, 5]);
    /// let sum = collection.reduce_async(|acc, x| async move { acc + x }, 0).await;
    /// assert_eq!(sum, 15);
    /// # }
    /// ```
    pub async fn reduce_async<U, F, Fut>(&self, iteratee: F, initial: U) -> U
    where
        F: Fn(U, &T) -> Fut,
        Fut: Future<Output = U>,
    {
        reduce_async(&self.data, iteratee, initial).await
    }

    /// Async version of `for_each`.
    /// 
    /// # Examples
    /// 
    /// ```
    /// use rust_lodash::collection::Collection;
    /// 
    /// # async fn example() {
    /// let collection = Collection::new(vec![1, 2, 3, 4, 5]);
    /// let mut sum = 0;
    /// collection.for_each_async(|x| async move { sum += x }).await;
    /// assert_eq!(sum, 15);
    /// # }
    /// ```
    pub async fn for_each_async<F, Fut>(&self, iteratee: F)
    where
        F: Fn(&T) -> Fut,
        Fut: Future<Output = ()>,
    {
        for_each_async(&self.data, iteratee).await
    }

    /// Async version of `find`.
    /// 
    /// # Examples
    /// 
    /// ```
    /// use rust_lodash::collection::Collection;
    /// 
    /// # async fn example() {
    /// let collection = Collection::new(vec![1, 2, 3, 4, 5]);
    /// let first_even = collection.find_async(|x| async move { x % 2 == 0 }).await;
    /// assert_eq!(first_even, Some(&2));
    /// # }
    /// ```
    pub async fn find_async<F, Fut>(&self, predicate: F) -> Option<&T>
    where
        F: Fn(&T) -> Fut,
        Fut: Future<Output = bool>,
    {
        find_async(&self.data, predicate).await
    }

    /// Async version of `every`.
    /// 
    /// # Examples
    /// 
    /// ```
    /// use rust_lodash::collection::Collection;
    /// 
    /// # async fn example() {
    /// let collection = Collection::new(vec![2, 4, 6, 8]);
    /// let all_even = collection.every_async(|x| async move { x % 2 == 0 }).await;
    /// assert!(all_even);
    /// # }
    /// ```
    pub async fn every_async<F, Fut>(&self, predicate: F) -> bool
    where
        F: Fn(&T) -> Fut,
        Fut: Future<Output = bool>,
    {
        every_async(&self.data, predicate).await
    }

    /// Async version of `some`.
    /// 
    /// # Examples
    /// 
    /// ```
    /// use rust_lodash::collection::Collection;
    /// 
    /// # async fn example() {
    /// let collection = Collection::new(vec![1, 3, 5, 7]);
    /// let has_even = collection.some_async(|x| async move { x % 2 == 0 }).await;
    /// assert!(!has_even);
    /// # }
    /// ```
    pub async fn some_async<F, Fut>(&self, predicate: F) -> bool
    where
        F: Fn(&T) -> Fut,
        Fut: Future<Output = bool>,
    {
        some_async(&self.data, predicate).await
    }
}

#[cfg(test)]
#[cfg(feature = "async")]
mod tests {
    use super::*;
    use tokio_test;

    #[tokio::test]
    async fn test_map_async() {
        let numbers = vec![1, 2, 3, 4, 5];
        let doubled = map_async(&numbers, |x| async move { x * 2 }).await;
        assert_eq!(doubled, vec![2, 4, 6, 8, 10]);
    }

    #[tokio::test]
    async fn test_filter_async() {
        let numbers = vec![1, 2, 3, 4, 5];
        let evens = filter_async(&numbers, |x| async move { x % 2 == 0 }).await;
        assert_eq!(evens, vec![2, 4]);
    }

    #[tokio::test]
    async fn test_reduce_async() {
        let numbers = vec![1, 2, 3, 4, 5];
        let sum = reduce_async(&numbers, |acc, x| async move { acc + x }, 0).await;
        assert_eq!(sum, 15);
    }

    #[tokio::test]
    async fn test_for_each_async() {
        let numbers = vec![1, 2, 3, 4, 5];
        let mut sum = 0;
        for_each_async(&numbers, |x| async move { sum += x }).await;
        assert_eq!(sum, 15);
    }

    #[tokio::test]
    async fn test_find_async() {
        let numbers = vec![1, 2, 3, 4, 5];
        let first_even = find_async(&numbers, |x| async move { x % 2 == 0 }).await;
        assert_eq!(first_even, Some(&2));
    }

    #[tokio::test]
    async fn test_every_async() {
        let numbers = vec![2, 4, 6, 8];
        let all_even = every_async(&numbers, |x| async move { x % 2 == 0 }).await;
        assert!(all_even);
    }

    #[tokio::test]
    async fn test_some_async() {
        let numbers = vec![1, 3, 5, 7];
        let has_even = some_async(&numbers, |x| async move { x % 2 == 0 }).await;
        assert!(!has_even);
    }

    #[tokio::test]
    async fn test_collection_map_async() {
        let collection = Collection::new(vec![1, 2, 3, 4, 5]);
        let doubled = collection.map_async(|x| async move { x * 2 }).await;
        assert_eq!(doubled, vec![2, 4, 6, 8, 10]);
    }

    #[tokio::test]
    async fn test_collection_filter_async() {
        let collection = Collection::new(vec![1, 2, 3, 4, 5]);
        let evens = collection.filter_async(|x| async move { x % 2 == 0 }).await;
        assert_eq!(evens, vec![2, 4]);
    }

    #[tokio::test]
    async fn test_collection_reduce_async() {
        let collection = Collection::new(vec![1, 2, 3, 4, 5]);
        let sum = collection.reduce_async(|acc, x| async move { acc + x }, 0).await;
        assert_eq!(sum, 15);
    }

    #[tokio::test]
    async fn test_collection_for_each_async() {
        let collection = Collection::new(vec![1, 2, 3, 4, 5]);
        let mut sum = 0;
        collection.for_each_async(|x| async move { sum += x }).await;
        assert_eq!(sum, 15);
    }

    #[tokio::test]
    async fn test_collection_find_async() {
        let collection = Collection::new(vec![1, 2, 3, 4, 5]);
        let first_even = collection.find_async(|x| async move { x % 2 == 0 }).await;
        assert_eq!(first_even, Some(&2));
    }

    #[tokio::test]
    async fn test_collection_every_async() {
        let collection = Collection::new(vec![2, 4, 6, 8]);
        let all_even = collection.every_async(|x| async move { x % 2 == 0 }).await;
        assert!(all_even);
    }

    #[tokio::test]
    async fn test_collection_some_async() {
        let collection = Collection::new(vec![1, 3, 5, 7]);
        let has_even = collection.some_async(|x| async move { x % 2 == 0 }).await;
        assert!(!has_even);
    }

    #[tokio::test]
    async fn test_empty_collection_async() {
        let empty: Vec<i32> = vec![];
        let doubled = map_async(&empty, |x| async move { x * 2 }).await;
        assert!(doubled.is_empty());

        let evens = filter_async(&empty, |x| async move { x % 2 == 0 }).await;
        assert!(evens.is_empty());

        let sum = reduce_async(&empty, |acc, x| async move { acc + x }, 0).await;
        assert_eq!(sum, 0);

        let first_even = find_async(&empty, |x| async move { x % 2 == 0 }).await;
        assert_eq!(first_even, None);

        let all_even = every_async(&empty, |x| async move { x % 2 == 0 }).await;
        assert!(all_even); // vacuous truth

        let has_even = some_async(&empty, |x| async move { x % 2 == 0 }).await;
        assert!(!has_even); // vacuous false
    }
}