arrayy 0.1.2

Stack-allocated fixed-size array with useful methods on top of Rust's [T; L] type.
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

# arrayy


Stack-allocated fixed-size array with useful methods on top of Rust's `[T; L]` type.

## Methods


- [`new`](https://docs.rs/arrayy/latest/arrayy/struct.Array.html#method.new)
- [`len`](https://docs.rs/arrayy/latest/arrayy/struct.Array.html#method.len)
- [`set_len`](https://docs.rs/arrayy/latest/arrayy/struct.Array.html#method.set_len)
- [`set_len_unchecked`](https://docs.rs/arrayy/latest/arrayy/struct.Array.html#method.set_len_unchecked)
- [`buf`](https://docs.rs/arrayy/latest/arrayy/struct.Array.html#method.buf)
- [`buf_mut`](https://docs.rs/arrayy/latest/arrayy/struct.Array.html#method.buf_mut)
- [`capacity`](https://docs.rs/arrayy/latest/arrayy/struct.Array.html#method.capacity)
- [`is_empty`](https://docs.rs/arrayy/latest/arrayy/struct.Array.html#method.is_empty)
- [`get`](https://docs.rs/arrayy/latest/arrayy/struct.Array.html#method.get)
- [`get_mut`](https://docs.rs/arrayy/latest/arrayy/struct.Array.html#method.get_mut)
- [`get_unchecked`](https://docs.rs/arrayy/latest/arrayy/struct.Array.html#method.get_unchecked)
- [`get_unchecked_mut`](https://docs.rs/arrayy/latest/arrayy/struct.Array.html#method.get_unchecked_mut)
- [`last`](https://docs.rs/arrayy/latest/arrayy/struct.Array.html#method.last)
- [`last_mut`](https://docs.rs/arrayy/latest/arrayy/struct.Array.html#method.last_mut)
- [`first`](https://docs.rs/arrayy/latest/arrayy/struct.Array.html#method.first)
- [`first_mut`](https://docs.rs/arrayy/latest/arrayy/struct.Array.html#method.first_mut)
- [`from`](https://docs.rs/arrayy/latest/arrayy/struct.Array.html#method.from)
- [`push`](https://docs.rs/arrayy/latest/arrayy/struct.Array.html#method.push)
- [`push_unchecked`](https://docs.rs/arrayy/latest/arrayy/struct.Array.html#method.push_unchecked)
- [`pop`](https://docs.rs/arrayy/latest/arrayy/struct.Array.html#method.pop)
- [`pop_unchecked`](https://docs.rs/arrayy/latest/arrayy/struct.Array.html#method.pop_unchecked)
- [`iter`](https://docs.rs/arrayy/latest/arrayy/struct.Array.html#method.iter)
- [`iter_mut`](https://docs.rs/arrayy/latest/arrayy/struct.Array.html#method.iter_mut)
- [`into_iter`](https://docs.rs/arrayy/latest/arrayy/struct.Array.html#method.into_iter)
- [`append`](https://docs.rs/arrayy/latest/arrayy/struct.Array.html#method.append)
- [`append_slice`](https://docs.rs/arrayy/latest/arrayy/struct.Array.html#method.append_slice)
- [`append_unchecked`](https://docs.rs/arrayy/latest/arrayy/struct.Array.html#method.append_unchecked)
- [`append_slice_unchecked`](https://docs.rs/arrayy/latest/arrayy/struct.Array.html#method.append_slice_unchecked)
- [`filter`](https://docs.rs/arrayy/latest/arrayy/struct.Array.html#method.filter)
- [`map`](https://docs.rs/arrayy/latest/arrayy/struct.Array.html#method.map)
- [`truncate`](https://docs.rs/arrayy/latest/arrayy/struct.Array.html#method.truncate)
- [`as_slice`](https://docs.rs/arrayy/latest/arrayy/struct.Array.html#method.as_slice)
- [`as_mut_slice`](https://docs.rs/arrayy/latest/arrayy/struct.Array.html#method.as_mut_slice)
- [`as_vec`](https://docs.rs/arrayy/latest/arrayy/struct.Array.html#method.as_vec)
- [`insert`](https://docs.rs/arrayy/latest/arrayy/struct.Array.html#method.insert)
- [`insert_unchecked`](https://docs.rs/arrayy/latest/arrayy/struct.Array.html#method.insert_unchecked)
- [`remove`](https://docs.rs/arrayy/latest/arrayy/struct.Array.html#method.remove)
- [`remove_unchecked`](https://docs.rs/arrayy/latest/arrayy/struct.Array.html#method.remove_unchecked)
- [`clear`](https://docs.rs/arrayy/latest/arrayy/struct.Array.html#method.clear)
- [`as_mut_ptr`](https://docs.rs/arrayy/latest/arrayy/struct.Array.html#method.as_mut_ptr)
- [`as_ptr`](https://docs.rs/arrayy/latest/arrayy/struct.Array.html#method.as_ptr)
- [`as_mut_ptr_range`](https://docs.rs/arrayy/latest/arrayy/struct.Array.html#method.as_mut_ptr_range)
- [`as_ptr_range`](https://docs.rs/arrayy/latest/arrayy/struct.Array.html#method.as_ptr_range)

## Examples


### Creating an Array


```rust
use arrayy::{array, Array};

let a = array![u8; 10]; // empty array (len = 0) with capacity = 10
// same as
let a: Array<u8, 10> = Array::default();

let b = array![1u8, 2, 3; 10]; // array with 3 elements (len = 3) and capacity = 10
// same as
let b = Array::<u8, 10>::from(&[1, 2, 3]);

let c = array![1u8, 2, 3]; // array with 3 elements (len = 3) and capacity = 3
// same as
let c = Array::<u8, 3>::from(&[1, 2, 3]);
```

### Basic Operations


```rust
let mut arr = array![1, 2, 3; 10];
arr.push(4);
assert_eq!(arr.len(), 4);
assert_eq!(arr.pop(), Some(4));
assert_eq!(arr.len(), 3);
```

### Accessing Elements


```rust
let arr = array![1, 2, 3];
assert_eq!(arr[1], 2);
assert_eq!(arr.get(1), Some(&2));
assert_eq!(arr.first(), Some(&1));
assert_eq!(arr.last(), Some(&3));
```

### Iterating Over Elements


```rust
let arr = array![1, 2, 3];
for val in arr.iter() {
    println!("{}", val);
}

let mut arr = array![1, 2, 3];
for val in arr.iter_mut() {
    *val *= 2;
}
assert_eq!(arr, array![2, 4, 6]);
```

### Filtering and Mapping


```rust
let arr = array![1, 2, 3, 4, 5];
let filtered = arr.filter(|&x| x % 2 == 0);
assert_eq!(filtered, array![2, 4]);

let mapped = arr.map(|&x| x * 2);
assert_eq!(mapped, array![2, 4, 6, 8, 10]);
```

### Appending Arrays


```rust
let mut arr1 = array![1, 2, 3; 5];
let arr2 = array![4, 5];
arr1.append(&arr2);
assert_eq!(arr1, array![1, 2, 3, 4, 5]);
```