light-zero-copy 0.7.0

Zero copy vector and utils for Solana programs.
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
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
#![cfg(feature = "std")]
use std::fmt::Debug;

use light_zero_copy::{
    add_padding,
    errors::ZeroCopyError,
    vec::{ZeroCopyVec, ZeroCopyVecU64},
    ZeroCopyTraits,
};
use rand::{
    distributions::{Distribution, Standard},
    thread_rng, Rng,
};
use zerocopy::{FromBytes, Immutable, IntoBytes, KnownLayout};

/// Generates a random value, excluding the values provided
/// in `exclude`.
fn gen_exclude<N, T>(rng: &mut N, exclude: &[T]) -> T
where
    N: Rng,
    T: PartialEq,
    Standard: Distribution<T>,
{
    loop {
        // This utility is supposed to be used only in unit tests. This `clone`
        // is harmless and necessary (can't pass a reference to range, it has
        // to be moved).
        let sample = rng.gen();
        if !exclude.contains(&sample) {
            return sample;
        }
    }
}

#[test]
fn test_zero_copy_vec() {
    test_zero_copy_vec_new::<u8, u32>(u8::MAX);
    println!("test_zero_copy_vec_with_capacity::<u8>()");
    test_zero_copy_vec_new::<u16, u32>(u8::MAX as u16);
    println!("test_zero_copy_vec_with_capacity::<u16>()");
    test_zero_copy_vec_new::<u32, u32>(u8::MAX as u32);
    println!("test_zero_copy_vec_with_capacity::<u32>()");
    test_zero_copy_vec_new::<u64, u32>(u8::MAX as u64);
    println!("test_zero_copy_vec_with_capacity::<u64>()");
    test_zero_copy_vec_new::<u64, u32>(10000);
}

#[test]
fn test_zero_copy_u64_struct_vec() {
    #[derive(
        Copy, Clone, PartialEq, Debug, Default, Immutable, FromBytes, KnownLayout, IntoBytes,
    )]
    struct TestStruct {
        a: u32,
        aa: u32,
        b: u64,
        c: u16,
        cc: u16,
        ccc: u32,
        d: [u8; 32],
    }
    impl Distribution<TestStruct> for Standard {
        fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> TestStruct {
            TestStruct {
                a: rng.gen(),
                aa: rng.gen(),
                b: rng.gen(),
                c: rng.gen(),
                cc: rng.gen(),
                ccc: rng.gen(),
                d: rng.gen(),
            }
        }
    }

    test_zero_copy_vec_new::<u8, TestStruct>(u8::MAX);
    test_zero_copy_vec_new::<u16, TestStruct>(u8::MAX as u16);
    test_zero_copy_vec_new::<u32, TestStruct>(u8::MAX as u32);
    test_zero_copy_vec_new::<u64, TestStruct>(u8::MAX as u64);
}

#[test]
fn test_zero_copy_u8_struct_vec() {
    #[derive(
        Copy, Clone, PartialEq, Debug, Default, Immutable, FromBytes, KnownLayout, IntoBytes,
    )]
    struct TestStruct {
        a: [u8; 32],
    }
    impl Distribution<TestStruct> for Standard {
        fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> TestStruct {
            TestStruct { a: rng.gen() }
        }
    }

    test_zero_copy_vec_new::<u8, TestStruct>(u8::MAX);
    test_zero_copy_vec_new::<u16, TestStruct>(u8::MAX as u16);
    test_zero_copy_vec_new::<u32, TestStruct>(u8::MAX as u32);
    test_zero_copy_vec_new::<u64, TestStruct>(u8::MAX as u64);
}

fn test_zero_copy_vec_new<CAPACITY, T>(capacity: CAPACITY)
where
    CAPACITY: ZeroCopyTraits + Debug + PartialEq,
    T: ZeroCopyTraits + Debug + PartialEq + Copy,
    u64: From<CAPACITY> + TryInto<CAPACITY>,
    Standard: Distribution<T>,
{
    let mut rng = thread_rng();
    let mut data = vec![0; ZeroCopyVec::<CAPACITY, T>::required_size_for_capacity(capacity)];
    println!("data len: {}", data.len());
    println!("capacity: {:?}", capacity);
    // new
    {
        let zero_copy_vec = ZeroCopyVec::<CAPACITY, T>::new(capacity, &mut data).unwrap();
        assert_eq!(zero_copy_vec.capacity() as u64, capacity.into());
        assert_eq!(zero_copy_vec.len(), 0);
        assert!(zero_copy_vec.is_empty());
    }
    println!("new {:?}", data[0..8].to_vec());
    // empty from bytes
    {
        let reference_vec = vec![];
        let vec = ZeroCopyVec::<CAPACITY, T>::from_bytes(&mut data).unwrap();
        assert_empty_vec(capacity, reference_vec, vec);
        {
            let data = data.clone();
            let len_size = size_of::<CAPACITY>();
            let length = data[0..len_size].to_vec();
            // set capacity
            assert_eq!(length[0], 0);
            let capacity_size = size_of::<CAPACITY>();
            let mut length = data[len_size..capacity_size + len_size].to_vec();
            while length.len() < 8 {
                length.push(0);
            }
            assert_eq!(length, u64::from(capacity).to_le_bytes().as_ref().to_vec());
            let mut metadata_size = size_of::<[CAPACITY; 2]>();

            let padding_start = metadata_size;
            add_padding::<[CAPACITY; 2], T>(&mut metadata_size);
            let padding_end = metadata_size;
            let data = data[padding_start..padding_end].to_vec();
            // Padding should be zeroed
            assert_eq!(data, vec![0; padding_end - padding_start]);
        }
    }
    let capacity_usize: usize = (u64::from(capacity)) as usize;
    let mut reference_vec = vec![];
    // fill vector completely and assert:
    {
        // 1. vector is not empty
        // 2. vector length is correct
        // 3. vector capacity is correct
        // 4. vector elements can be accessed by index
        // 5. vector elements can be accessed by get
        // 6. vector elements can be accessed by get_mut
        // 7. vector last element can be accessed
        // 8. vector last element can be accessed mutably
        // 9. vector first element can be accessed
        // 10. vector first element can be accessed mutably
        // 11. vector as_slice returns correct slice
        // 12. vector as_mut_slice returns correct slice
        // 13. vector to_vec returns correct vector
        // 14. (iter) iterating over vector returns correct elements
        // 15. (iter_mut) iterating over vector mutably returns correct elements
        for i in 0..capacity_usize {
            let mut vec = ZeroCopyVec::<CAPACITY, T>::from_bytes(&mut data).unwrap();

            let element = rng.gen();
            vec.push(element).unwrap();
            reference_vec.push(element);
            // 1. vector is not empty
            assert!(!vec.is_empty());
            // 2. vector length is correct
            assert_eq!(vec.len(), i + 1);

            // 3. vector capacity is correct
            assert_eq!(vec.capacity(), capacity_usize);
            // 4. vector elements can be accessed by index
            assert_eq!(vec[i], element);
            // 5. vector elements can be accessed by get
            assert_eq!(vec.get(i), Some(&element));
            // 6. vector elements can be accessed by get_mut
            assert_eq!(vec.get_mut(i), Some(&mut reference_vec[i]));
            // 7. vector last element can be accessed
            assert_eq!(vec.last(), Some(&element));
            // 8. vector last element can be accessed mutably
            assert_eq!(vec.last_mut(), Some(&mut reference_vec[i]));
            // 9. vector first element can be accessed
            assert_eq!(vec.first(), Some(&reference_vec[0]));
            // 10. vector first element can be accessed mutably
            assert_eq!(vec.first_mut(), Some(&mut reference_vec[0]));
            // 11. vector as_slice returns correct slice
            assert_eq!(vec.as_slice(), reference_vec.as_slice());
            assert_ne!(&vec.as_slice()[1..], reference_vec.as_slice());
            // 12. vector as_mut_slice returns correct slice
            assert_eq!(vec.as_mut_slice(), reference_vec.as_mut_slice());
            assert_ne!(&vec.as_mut_slice()[1..], reference_vec.as_mut_slice());
            // 13. vector to_vec returns correct vector
            assert_eq!(vec.to_vec(), reference_vec);
            assert_ne!(vec.to_vec()[1..].to_vec(), reference_vec);
            // 14. (iter) iterating over vector returns correct elements
            for (index, element) in vec.iter().enumerate() {
                assert_eq!(*element, reference_vec[index]);
            }
            // 15. (iter_mut) iterating over vector mutably returns correct elements
            for (index, element) in vec.iter_mut().enumerate() {
                assert_eq!(*element, reference_vec[index]);
                let new_element = gen_exclude(&mut rng, &[*element]);
                *element = new_element;
                assert_ne!(element, &reference_vec[index]);
                reference_vec[index] = *element;
            }
            {
                let cloned_data: Vec<u8> = data.clone();
                let len_size = size_of::<CAPACITY>();
                let mut length = cloned_data[0..len_size].to_vec();
                while length.len() < 8 {
                    length.push(0);
                }
                assert_eq!(length, ((i as u64 + 1).to_ne_bytes().as_ref().to_vec()));
                let capacity_size = size_of::<CAPACITY>();
                let mut length = data[len_size..capacity_size + len_size].to_vec();
                while length.len() < 8 {
                    length.push(0);
                }
                assert_eq!(length, u64::from(capacity).to_le_bytes().as_ref().to_vec());
                let mut metadata_size = size_of::<[CAPACITY; 2]>();

                let padding_start = metadata_size;
                add_padding::<[CAPACITY; 2], T>(&mut metadata_size);
                let padding_end = metadata_size;
                let cloned_data = cloned_data[padding_start..padding_end].to_vec();
                // Padding should be zeroed
                assert_eq!(cloned_data, vec![0; padding_end - padding_start]);
            }
        }
    }
    // full vec from bytes
    {
        let mut vec = ZeroCopyVec::<CAPACITY, T>::from_bytes(&mut data).unwrap();
        assert_full_vec(
            capacity,
            &mut rng,
            capacity_usize,
            &mut reference_vec,
            &mut vec,
        );
        // Failing push into full vec
        let result = vec.push(rng.gen());
        assert_eq!(result, Err(ZeroCopyError::Full));
    }

    // clear
    {
        let mut vec = ZeroCopyVec::<CAPACITY, T>::from_bytes(&mut data).unwrap();
        let third = vec[3];
        vec.clear();
        assert_eq!(vec.len(), 0);
        assert_eq!(vec.capacity(), capacity_usize);
        assert!(vec.is_empty());
        assert_eq!(vec.as_slice(), &[]);
        assert_eq!(vec.as_mut_slice(), &mut []);
        if vec.iter().next().is_some() {
            panic!("Should not iterate over empty vector");
        }
        let index = vec.iter().position(|x| *x == third);
        assert_eq!(index, None);
        assert_ne!(vec.as_slice(), reference_vec.as_slice());
        assert_ne!(vec.as_mut_slice(), reference_vec.as_mut_slice());
        assert_ne!(vec.to_vec(), reference_vec);
        reference_vec.clear();
        assert_empty_vec(capacity, reference_vec, vec);
        {
            let data = data.clone();
            let len_size = size_of::<CAPACITY>();
            let mut length = data[0..len_size].to_vec();
            let ref_length: CAPACITY = 0u64
                .try_into()
                .map_err(|_| ZeroCopyError::InvalidConversion)
                .unwrap(); //;(0).to_usize().unwrap();
            while length.len() < 8 {
                length.push(0);
            }
            assert_eq!(
                length,
                u64::from(ref_length).to_le_bytes().as_ref().to_vec()
            );

            let capacity_size = size_of::<CAPACITY>();
            let mut length = data[len_size..capacity_size + len_size].to_vec();
            while length.len() < 8 {
                length.push(0);
            }
            assert_eq!(length, u64::from(capacity).to_le_bytes().as_ref().to_vec());

            let mut metadata_size = size_of::<[CAPACITY; 2]>();

            let padding_start = metadata_size;
            add_padding::<[CAPACITY; 2], T>(&mut metadata_size);
            let padding_end = metadata_size;
            assert_eq!(
                data[..size_of::<CAPACITY>()].to_vec(),
                vec![0; size_of::<CAPACITY>()]
            );
            let data = data[padding_start..padding_end].to_vec();
            // Padding should be zeroed
            assert_eq!(data, vec![0; padding_end - padding_start]);
        }
    }
}

fn assert_full_vec<CAPACITY, T>(
    capacity: CAPACITY,
    rng: &mut rand::prelude::ThreadRng,
    capacity_usize: usize,
    reference_vec: &mut Vec<T>,
    vec: &mut ZeroCopyVec<CAPACITY, T>,
) where
    CAPACITY: ZeroCopyTraits + Debug + PartialEq,
    T: ZeroCopyTraits + Debug + PartialEq,
    Standard: Distribution<T>,
    u64: From<CAPACITY> + TryInto<CAPACITY>,
{
    // 1. vector capacity is correct
    assert_eq!(vec.capacity() as u64, capacity.into());
    // 2. vector length is correct
    assert_eq!(vec.len(), capacity_usize);
    // 3. vector is not empty
    assert!(!vec.is_empty());
    // 4. vector as slice returns correct slice
    assert_eq!(vec.as_slice(), reference_vec.as_slice());
    assert_ne!(&vec.as_slice()[1..], reference_vec.as_slice());
    // 5. vector as_mut_slice returns correct slice
    assert_eq!(vec.as_mut_slice(), reference_vec.as_mut_slice());
    assert_ne!(&vec.as_mut_slice()[1..], reference_vec.as_mut_slice());
    // 6. vector to_vec returns correct vector
    assert_eq!(vec.to_vec(), *reference_vec);
    assert_ne!(vec.to_vec()[1..].to_vec(), *reference_vec);
    // 7. (iter) iterating over vector returns correct elements
    for (index, element) in vec.iter().enumerate() {
        assert_eq!(*element, reference_vec[index]);
    }
    // 8. (iter_mut) iterating over vector mutably returns correct elements
    for (index, element) in vec.iter_mut().enumerate() {
        assert_eq!(*element, reference_vec[index]);
        *element = rng.gen();
        assert_ne!(element, &reference_vec[index]);
        reference_vec[index] = *element;
    }
}

fn assert_empty_vec<CAPACITY, T>(
    capacity: CAPACITY,
    mut reference_vec: Vec<T>,
    mut vec: ZeroCopyVec<CAPACITY, T>,
) where
    CAPACITY: ZeroCopyTraits + Debug + PartialEq,
    T: ZeroCopyTraits + Debug + PartialEq + Copy,
    u64: From<CAPACITY> + TryInto<CAPACITY>,
{
    // 1. vector capacity is correct
    assert_eq!(vec.capacity() as u64, capacity.into());
    // 2. vector length is correct
    assert_eq!(vec.len(), 0);
    // 3. vector is empty
    assert!(vec.is_empty());
    // 4. vector elements can be accessed by get
    assert_eq!(vec.get(0), None);
    // 5. vector elements can be accessed by get_mut
    assert_eq!(vec.get_mut(0), None);
    // 6. vector last element can be accessed
    assert_eq!(vec.last(), None);
    // 7. vector last element can be accessed mutably
    assert_eq!(vec.last_mut(), None);
    // 8. vector first element can be accessed
    assert_eq!(vec.first(), None);
    // 9. vector first element can be accessed mutably
    assert_eq!(vec.first_mut(), None);
    // 10. vector as_slice returns correct slice
    assert_eq!(vec.as_slice(), reference_vec.as_slice());
    // 11. vector as_mut_slice returns correct slice
    assert_eq!(vec.as_mut_slice(), reference_vec.as_mut_slice());

    // 12. vector to_vec returns correct vector
    assert_eq!(vec.to_vec(), reference_vec);
    // 13. (iter) iterating over vector returns correct elements
    assert!(
        vec.iter().next().is_none(),
        "Should not iterate over empty vector"
    );
    // 14. (iter_mut) iterating over vector mutably returns correct elements
    assert!(
        vec.iter_mut().next().is_none(),
        "Should not iterate over empty vector"
    );
}

#[test]
fn test_zero_copy_vec_to_array() {
    let capacity = 16;
    let mut data = vec![0; ZeroCopyVecU64::<u32>::required_size_for_capacity(capacity)];
    let mut vec = ZeroCopyVecU64::<u32>::new(capacity, &mut data).unwrap();
    vec.extend_from_slice(&[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15])
        .unwrap();

    let arr: [u32; 16] = vec.try_into_array().unwrap();
    assert_eq!(arr, [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15]);

    assert!(matches!(
        vec.try_into_array::<15>(),
        Err(ZeroCopyError::ArraySize(_, _))
    ));
    assert!(matches!(
        vec.try_into_array::<17>(),
        Err(ZeroCopyError::ArraySize(_, _))
    ));
}

#[test]
fn test_zero_copy_vec_into_iter() {
    let capacity = 1000;
    let mut data = vec![0; ZeroCopyVecU64::<usize>::required_size_for_capacity(capacity)];
    let mut vec = ZeroCopyVecU64::<usize>::new(capacity, &mut data).unwrap();

    for i in 0..1000 {
        vec.push(i).unwrap();
    }

    for (i, element) in vec.into_iter().enumerate() {
        assert_eq!(*element, i);
    }
}

#[test]
fn test_metadata_size() {
    assert_eq!(ZeroCopyVec::<u8, u8>::metadata_size(), 2);
    assert_eq!(ZeroCopyVec::<u16, u8>::metadata_size(), 4);
    assert_eq!(ZeroCopyVec::<u32, u8>::metadata_size(), 8);
    assert_eq!(ZeroCopyVec::<u64, u8>::metadata_size(), 16);

    assert_eq!(ZeroCopyVec::<u8, u16>::metadata_size(), 2);
    assert_eq!(ZeroCopyVec::<u16, u16>::metadata_size(), 4);
    assert_eq!(ZeroCopyVec::<u32, u16>::metadata_size(), 8);
    assert_eq!(ZeroCopyVec::<u64, u16>::metadata_size(), 16);

    assert_eq!(ZeroCopyVec::<u8, u32>::metadata_size(), 4);
    assert_eq!(ZeroCopyVec::<u16, u32>::metadata_size(), 4);
    assert_eq!(ZeroCopyVec::<u32, u32>::metadata_size(), 8);
    assert_eq!(ZeroCopyVec::<u64, u32>::metadata_size(), 16);

    assert_eq!(ZeroCopyVec::<u8, u64>::metadata_size(), 8);
    assert_eq!(ZeroCopyVec::<u16, u64>::metadata_size(), 8);
    assert_eq!(ZeroCopyVec::<u32, u64>::metadata_size(), 8);
    assert_eq!(ZeroCopyVec::<u64, u64>::metadata_size(), 16);
}

#[test]
fn test_data_size() {
    assert_eq!(ZeroCopyVec::<u8, u8>::data_size(64), 64);
}

#[test]
fn test_required_size() {
    // length + capacity + data
    assert_eq!(
        ZeroCopyVec::<u8, u8>::required_size_for_capacity(64),
        1 + 1 + 64
    );
    // length + capacity + data
    assert_eq!(
        ZeroCopyVec::<u64, u64>::required_size_for_capacity(64),
        8 + 8 + 8 * 64
    );
}

#[test]
fn test_partial_eq() {
    let mut account_data = vec![0u8; ZeroCopyVecU64::<u64>::required_size_for_capacity(5)];
    let mut vec = ZeroCopyVecU64::<u64>::new(5, &mut account_data).unwrap();
    for i in 0..4 {
        vec.push(i as u64).unwrap();
    }

    let mut account_data = vec![0u8; ZeroCopyVecU64::<u64>::required_size_for_capacity(5)];
    let mut vec2 = ZeroCopyVecU64::<u64>::new(5, &mut account_data).unwrap();
    for i in 0..4 {
        vec2.push(i as u64).unwrap();
    }

    assert_eq!(vec, vec2);

    vec2.push(5).unwrap();
    assert_ne!(vec, vec2);
    vec.push(5).unwrap();
    assert_eq!(vec, vec2);
    vec.clear();
    assert_ne!(vec, vec2);
}

#[test]
fn test_new_memory_not_zeroed() {
    let capacity = 5;
    let mut data = vec![1; ZeroCopyVecU64::<u64>::required_size_for_capacity(capacity)];
    let vec = ZeroCopyVecU64::<u64>::new(capacity, &mut data);
    assert!(matches!(vec, Err(ZeroCopyError::MemoryNotZeroed)));
}

#[test]
fn test_extend_from_slice_over_capacity() {
    let capacity = 5;
    let mut data = vec![0; ZeroCopyVecU64::<u64>::required_size_for_capacity(capacity)];
    let mut vec = ZeroCopyVecU64::<u64>::new(capacity, &mut data).unwrap();
    let slice = [1, 2, 3, 4, 5, 6];
    let result = vec.extend_from_slice(&slice);
    assert_eq!(
        result.unwrap_err(),
        light_zero_copy::errors::ZeroCopyError::InsufficientCapacity
    );
}

#[test]
fn test_extend_from_slice_over_capacity_2() {
    let capacity = 5;
    let mut data = vec![0; ZeroCopyVecU64::<u64>::required_size_for_capacity(capacity)];
    let mut vec = ZeroCopyVecU64::<u64>::new(capacity, &mut data).unwrap();
    let slice = [1, 2, 3, 4, 5];
    vec.extend_from_slice(&slice).unwrap();
    let slice = [1];
    let result = vec.extend_from_slice(&slice);
    assert_eq!(
        result.unwrap_err(),
        light_zero_copy::errors::ZeroCopyError::InsufficientCapacity
    );
}

#[test]
fn test_extend_from_slice() {
    let capacity = 5;
    let mut data = vec![0; ZeroCopyVecU64::<u64>::required_size_for_capacity(capacity)];
    let mut vec = ZeroCopyVecU64::<u64>::new(capacity, &mut data).unwrap();
    let slice = [1, 2, 3, 4, 5];
    vec.extend_from_slice(&slice).unwrap();
}

#[test]
fn test_into_iter_mutable() {
    let mut buffer = vec![0u8; 32];
    let length: u64 = 4;
    let values = [1u32, 2, 3, 4];
    let (mut slice, _) = ZeroCopyVecU64::<u32>::new_at(length, &mut buffer)
        .expect("Failed to create ZeroCopyVeceMut");
    for value in &values {
        slice.push(*value).expect("Failed to push value");
    }
    for x in &mut slice {
        *x += 10;
    }
    assert_eq!(slice.as_slice(), &[11, 12, 13, 14]);
}

#[test]
fn test_debug_fmt() {
    let mut buffer = vec![0u8; 32];
    let length: u64 = 4;
    let values = [1u32, 2, 3, 4];

    let (mut slice, _) = ZeroCopyVecU64::<u32>::new_at(length, &mut buffer)
        .expect("Failed to create ZeroCopyVeceMut");
    for value in &values {
        slice.push(*value).expect("Failed to push value");
    }

    assert_eq!(format!("{:?}", slice), "[1, 2, 3, 4]");
}

#[test]
fn test_from_bytes_at_failing() {
    let buffer_len = ZeroCopyVecU64::<u32>::required_size_for_capacity(4);
    let metadata_len = ZeroCopyVecU64::<u32>::metadata_size();
    let data_len = ZeroCopyVecU64::<u32>::data_size(4);

    let mut buffer = vec![0u8; buffer_len];
    let length: u64 = 4;

    ZeroCopyVecU64::<u32>::new_at(length, &mut buffer).expect("Failed to create ZeroCopyVecMut");

    let result = ZeroCopyVecU64::<u32>::from_bytes_at(&mut buffer[..metadata_len - 1]);
    assert_eq!(
        result,
        Err(ZeroCopyError::InsufficientMemoryAllocated(
            metadata_len - 1,
            metadata_len,
        ))
    );

    let result = ZeroCopyVecU64::<u32>::from_bytes_at(&mut buffer[..buffer_len - 1]);
    assert_eq!(
        result,
        Err(ZeroCopyError::InsufficientMemoryAllocated(
            metadata_len + data_len - 1,
            metadata_len + data_len,
        ))
    );

    {
        // set length greater than capacity
        let length: u64 = 5;
        buffer[0..8].copy_from_slice(&length.to_le_bytes());
        let result = ZeroCopyVecU64::<u32>::from_bytes_at(&mut buffer);
        assert_eq!(result, Err(ZeroCopyError::LengthGreaterThanCapacity));
    }
}

#[test]
fn test_private_getters() {
    let mut backing_store = [0u8; 64];
    let mut zcv = ZeroCopyVec::<u16, u16>::new(5, &mut backing_store).unwrap();
    zcv.push(10).unwrap();
    zcv.push(20).unwrap();
    zcv.push(30).unwrap();
    zcv[1] = 99;
    assert_eq!(zcv[0], 10);
    assert_eq!(zcv[1], 99);
    assert_eq!(zcv[2], 30);
}