orx-pinned-vec 3.23.0

`PinnedVec` trait defines the interface for vectors which guarantee that elements added to the vector are pinned to their memory locations unless explicitly changed.
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

use crate::utils::slice::index_of_ptr;
use alloc::vec;

#[test]
fn index_of_ptr_empty_slice() {
    let slice: &[u8] = &[];
    let ptr_to_check = slice.as_ptr();
    let idx = index_of_ptr(slice, ptr_to_check);
    assert_eq!(idx, None);
}

#[test]
fn index_of_ptr_out_of_bounds() {
    let vec = vec![0, 1, 2, 3, 4, 5, 6, 7];

    let ptr_to_check = unsafe { vec.as_ptr().add(4) };
    assert_eq!(unsafe { *ptr_to_check }, 4);

    let idx = index_of_ptr(&vec[0..3], ptr_to_check);
    assert_eq!(idx, None);

    let idx = index_of_ptr(&vec[0..4], ptr_to_check);
    assert_eq!(idx, None);

    let idx = index_of_ptr(&vec[5..], ptr_to_check);
    assert_eq!(idx, None);
}

#[test]
fn index_of_ptr_in_bounds() {
    let vec = vec![0, 1, 2, 3, 4, 5];

    let ptr_to_check = unsafe { vec.as_ptr().add(3) };
    assert_eq!(unsafe { *ptr_to_check }, 3);

    let idx = index_of_ptr(&vec[..], ptr_to_check);
    assert_eq!(idx, Some(3));

    let idx = index_of_ptr(&vec[0..4], ptr_to_check);
    assert_eq!(idx, Some(3));

    let idx = index_of_ptr(&vec[0..5], ptr_to_check);
    assert_eq!(idx, Some(3));

    let idx = index_of_ptr(&vec[1..], ptr_to_check);
    assert_eq!(idx, Some(2));

    let idx = index_of_ptr(&vec[2..], ptr_to_check);
    assert_eq!(idx, Some(1));

    let idx = index_of_ptr(&vec[3..], ptr_to_check);
    assert_eq!(idx, Some(0));
}

#[test]
fn index_of_ptr_different_allocation() {
    let vec1 = vec![0, 1, 2, 3, 4, 5];
    let ptr_to_check = unsafe { vec1.as_ptr().add(3) };
    assert_eq!(unsafe { *ptr_to_check }, 3);

    let vec2 = vec![0, 1, 2, 3, 4, 5];

    let idx = index_of_ptr(&vec2[..], ptr_to_check);
    assert_eq!(idx, None);

    let idx = index_of_ptr(&vec2[0..4], ptr_to_check);
    assert_eq!(idx, None);

    let idx = index_of_ptr(&vec2[0..5], ptr_to_check);
    assert_eq!(idx, None);

    let idx = index_of_ptr(&vec2[1..], ptr_to_check);
    assert_eq!(idx, None);

    let idx = index_of_ptr(&vec2[2..], ptr_to_check);
    assert_eq!(idx, None);

    let idx = index_of_ptr(&vec2[3..], ptr_to_check);
    assert_eq!(idx, None);
}