-
Notifications
You must be signed in to change notification settings - Fork 62
Expand file tree
/
Copy patharrayvec.rs
More file actions
2143 lines (1984 loc) · 55.6 KB
/
arrayvec.rs
File metadata and controls
2143 lines (1984 loc) · 55.6 KB
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
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
use super::*;
use core::convert::{TryFrom, TryInto};
#[cfg(feature = "serde")]
use core::marker::PhantomData;
#[cfg(feature = "serde")]
use serde::de::{
Deserialize, Deserializer, Error as DeserializeError, SeqAccess, Visitor,
};
#[cfg(feature = "serde")]
use serde::ser::{Serialize, SerializeSeq, Serializer};
/// Helper to make an `ArrayVec`.
///
/// You specify the backing array type, and optionally give all the elements you
/// want to initially place into the array.
///
/// ```rust
/// use tinyvec::*;
///
/// // The backing array type can be specified in the macro call
/// let empty_av = array_vec!([u8; 16]);
/// let some_ints = array_vec!([i32; 4] => 1, 2, 3);
///
/// // Or left to inference
/// let empty_av: ArrayVec<[u8; 10]> = array_vec!();
/// let some_ints: ArrayVec<[u8; 10]> = array_vec!(5, 6, 7, 8);
/// ```
#[macro_export]
macro_rules! array_vec {
($array_type:ty => $($elem:expr),* $(,)?) => {
{
let mut av: $crate::ArrayVec<$array_type> = Default::default();
$( av.push($elem); )*
av
}
};
($array_type:ty) => {
$crate::ArrayVec::<$array_type>::default()
};
($($elem:expr),*) => {
$crate::array_vec!(_ => $($elem),*)
};
($elem:expr; $n:expr) => {
$crate::ArrayVec::from([$elem; $n])
};
() => {
$crate::array_vec!(_)
};
}
/// An array-backed, vector-like data structure.
///
/// * `ArrayVec` has a fixed capacity, equal to the minimum of the array size
/// and `u16::MAX`. Note that not all capacities are necessarily supported by
/// default. See comments in [`Array`].
/// * `ArrayVec` has a variable length, as you add and remove elements. Attempts
/// to fill the vec beyond its capacity will cause a panic.
/// * All of the vec's array slots are always initialized in terms of Rust's
/// memory model. When you remove an element from a location, the old value at
/// that location is replaced with the type's default value.
///
/// The overall API of this type is intended to, as much as possible, emulate
/// the API of the [`Vec`](https://doc.rust-lang.org/alloc/vec/struct.Vec.html)
/// type.
///
/// ## Construction
///
/// You can use the `array_vec!` macro similarly to how you might use the `vec!`
/// macro. Specify the array type, then optionally give all the initial values
/// you want to have.
/// ```rust
/// # use tinyvec::*;
/// let some_ints = array_vec!([i32; 4] => 1, 2, 3);
/// assert_eq!(some_ints.len(), 3);
/// ```
///
/// The [`default`](ArrayVec::new) for an `ArrayVec` is to have a default
/// array with length 0. The [`new`](ArrayVec::new) method is the same as
/// calling `default`
/// ```rust
/// # use tinyvec::*;
/// let some_ints = ArrayVec::<[i32; 7]>::default();
/// assert_eq!(some_ints.len(), 0);
///
/// let more_ints = ArrayVec::<[i32; 7]>::new();
/// assert_eq!(some_ints, more_ints);
/// ```
///
/// If you have an array and want the _whole thing_ to count as being "in" the
/// new `ArrayVec` you can use one of the `from` implementations. If you want
/// _part of_ the array then you can use
/// [`from_array_len`](ArrayVec::from_array_len):
/// ```rust
/// # use tinyvec::*;
/// let some_ints = ArrayVec::from([5, 6, 7, 8]);
/// assert_eq!(some_ints.len(), 4);
///
/// let more_ints = ArrayVec::from_array_len([5, 6, 7, 8], 2);
/// assert_eq!(more_ints.len(), 2);
///
/// let no_ints: ArrayVec<[u8; 5]> = ArrayVec::from_array_empty([1, 2, 3, 4, 5]);
/// assert_eq!(no_ints.len(), 0);
/// ```
#[repr(C)]
pub struct ArrayVec<A> {
len: u16,
pub(crate) data: A,
}
impl<A> Clone for ArrayVec<A>
where
A: Array + Clone,
A::Item: Clone,
{
#[inline]
fn clone(&self) -> Self {
Self { data: self.data.clone(), len: self.len }
}
#[inline]
fn clone_from(&mut self, o: &Self) {
let iter = self
.data
.as_slice_mut()
.iter_mut()
.zip(o.data.as_slice())
.take(self.len.max(o.len) as usize);
for (dst, src) in iter {
dst.clone_from(src)
}
if let Some(to_drop) =
self.data.as_slice_mut().get_mut((o.len as usize)..(self.len as usize))
{
to_drop.iter_mut().for_each(|x| drop(core::mem::take(x)));
}
self.len = o.len;
}
}
impl<A> Copy for ArrayVec<A>
where
A: Array + Copy,
A::Item: Copy,
{
}
impl<A: Array> Default for ArrayVec<A> {
#[inline]
fn default() -> Self {
Self { len: 0, data: A::default() }
}
}
impl<A: Array> Deref for ArrayVec<A> {
type Target = [A::Item];
#[inline(always)]
fn deref(&self) -> &Self::Target {
&self.data.as_slice()[..self.len as usize]
}
}
impl<A: Array> DerefMut for ArrayVec<A> {
#[inline(always)]
fn deref_mut(&mut self) -> &mut Self::Target {
&mut self.data.as_slice_mut()[..self.len as usize]
}
}
impl<A: Array, I: SliceIndex<[A::Item]>> Index<I> for ArrayVec<A> {
type Output = <I as SliceIndex<[A::Item]>>::Output;
#[inline(always)]
fn index(&self, index: I) -> &Self::Output {
&self.deref()[index]
}
}
impl<A: Array, I: SliceIndex<[A::Item]>> IndexMut<I> for ArrayVec<A> {
#[inline(always)]
fn index_mut(&mut self, index: I) -> &mut Self::Output {
&mut self.deref_mut()[index]
}
}
#[cfg(feature = "serde")]
#[cfg_attr(docs_rs, doc(cfg(feature = "serde")))]
impl<A: Array> Serialize for ArrayVec<A>
where
A::Item: Serialize,
{
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where
S: Serializer,
{
let mut seq = serializer.serialize_seq(Some(self.len()))?;
for element in self.iter() {
seq.serialize_element(element)?;
}
seq.end()
}
}
#[cfg(feature = "serde")]
#[cfg_attr(docs_rs, doc(cfg(feature = "serde")))]
impl<'de, A: Array> Deserialize<'de> for ArrayVec<A>
where
A::Item: Deserialize<'de>,
{
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: Deserializer<'de>,
{
deserializer.deserialize_seq(ArrayVecVisitor(PhantomData))
}
}
#[cfg(feature = "borsh")]
#[cfg_attr(docs_rs, doc(cfg(feature = "borsh")))]
impl<A: Array> borsh::BorshSerialize for ArrayVec<A>
where
<A as Array>::Item: borsh::BorshSerialize,
{
fn serialize<W: borsh::io::Write>(
&self, writer: &mut W,
) -> borsh::io::Result<()> {
<usize as borsh::BorshSerialize>::serialize(&self.len(), writer)?;
for elem in self.iter() {
<<A as Array>::Item as borsh::BorshSerialize>::serialize(elem, writer)?;
}
Ok(())
}
}
#[cfg(feature = "borsh")]
#[cfg_attr(docs_rs, doc(cfg(feature = "borsh")))]
impl<A: Array> borsh::BorshDeserialize for ArrayVec<A>
where
<A as Array>::Item: borsh::BorshDeserialize,
{
fn deserialize_reader<R: borsh::io::Read>(
reader: &mut R,
) -> borsh::io::Result<Self> {
let len = <usize as borsh::BorshDeserialize>::deserialize_reader(reader)?;
let mut new_arrayvec = Self::default();
for idx in 0..len {
let value =
<<A as Array>::Item as borsh::BorshDeserialize>::deserialize_reader(
reader,
)?;
if idx >= new_arrayvec.capacity() {
return Err(borsh::io::Error::new(
borsh::io::ErrorKind::InvalidData,
"invalid ArrayVec length",
));
}
new_arrayvec.push(value)
}
Ok(new_arrayvec)
}
}
#[cfg(feature = "arbitrary")]
#[cfg_attr(docs_rs, doc(cfg(feature = "arbitrary")))]
impl<'a, A> arbitrary::Arbitrary<'a> for ArrayVec<A>
where
A: Array,
A::Item: arbitrary::Arbitrary<'a>,
{
fn arbitrary(u: &mut arbitrary::Unstructured<'a>) -> arbitrary::Result<Self> {
let max_len = A::CAPACITY.min(u16::MAX as usize) as u16;
let len = u.int_in_range::<u16>(0..=max_len)?;
let mut self_: Self = Default::default();
for _ in 0..len {
self_.push(u.arbitrary()?);
}
Ok(self_)
}
fn size_hint(depth: usize) -> (usize, Option<usize>) {
arbitrary::size_hint::recursion_guard(depth, |depth| {
let max_len = A::CAPACITY.min(u16::MAX as usize);
let inner = A::Item::size_hint(depth).1;
(0, inner.map(|inner| 2 + max_len * inner))
})
}
}
#[cfg(feature = "bin-proto")]
#[cfg_attr(docs_rs, doc(cfg(feature = "bin-proto")))]
impl<Ctx, A> bin_proto::BitEncode<Ctx, bin_proto::Untagged> for ArrayVec<A>
where
A: Array,
<A as Array>::Item: bin_proto::BitEncode<Ctx>,
{
fn encode<W, E>(
&self, write: &mut W, ctx: &mut Ctx, tag: bin_proto::Untagged,
) -> bin_proto::Result<()>
where
W: bin_proto::BitWrite,
E: bin_proto::Endianness,
{
<[<A as Array>::Item] as bin_proto::BitEncode<_, _>>::encode::<_, E>(
self.as_slice(),
write,
ctx,
tag,
)
}
}
#[cfg(feature = "bin-proto")]
#[cfg_attr(docs_rs, doc(cfg(feature = "bin-proto")))]
impl<Tag, Ctx, A> bin_proto::BitDecode<Ctx, bin_proto::Tag<Tag>> for ArrayVec<A>
where
A: Array,
<A as Array>::Item: bin_proto::BitDecode<Ctx>,
Tag: ::core::convert::TryInto<usize>,
{
fn decode<R, E>(
read: &mut R, ctx: &mut Ctx, tag: bin_proto::Tag<Tag>,
) -> bin_proto::Result<Self>
where
R: bin_proto::BitRead,
E: bin_proto::Endianness,
{
let item_count =
tag.0.try_into().map_err(|_| bin_proto::Error::TagConvert)?;
if item_count > A::CAPACITY {
return Err(bin_proto::Error::Other("insufficient capacity"));
}
let mut values = Self::default();
for _ in 0..item_count {
values.push(bin_proto::BitDecode::<_, _>::decode::<_, E>(read, ctx, ())?);
}
Ok(values)
}
}
#[cfg(feature = "bin-proto")]
#[cfg_attr(docs_rs, doc(cfg(feature = "bin-proto")))]
impl<Ctx, A> bin_proto::BitDecode<Ctx, bin_proto::Untagged> for ArrayVec<A>
where
A: Array,
<A as Array>::Item: bin_proto::BitDecode<Ctx>,
{
fn decode<R, E>(
read: &mut R, ctx: &mut Ctx, _tag: bin_proto::Untagged,
) -> bin_proto::Result<Self>
where
R: bin_proto::BitRead,
E: bin_proto::Endianness,
{
let mut values = Self::default();
for item in bin_proto::util::decode_items_to_eof::<_, E, _, _>(read, ctx) {
if values.try_push(item?).is_some() {
return Err(bin_proto::Error::Other("insufficient capacity"));
}
}
Ok(values)
}
}
impl<A: Array> ArrayVec<A> {
/// Move all values from `other` into this vec.
///
/// ## Panics
/// * If the vec overflows its capacity
///
/// ## Example
/// ```rust
/// # use tinyvec::*;
/// let mut av = array_vec!([i32; 10] => 1, 2, 3);
/// let mut av2 = array_vec!([i32; 10] => 4, 5, 6);
/// av.append(&mut av2);
/// assert_eq!(av, &[1, 2, 3, 4, 5, 6][..]);
/// assert_eq!(av2, &[][..]);
/// ```
#[inline]
pub fn append(&mut self, other: &mut Self) {
assert!(
self.try_append(other).is_none(),
"ArrayVec::append> total length {} exceeds capacity {}!",
self.len() + other.len(),
A::CAPACITY
);
}
/// Move all values from `other` into this vec.
/// If appending would overflow the capacity, Some(other) is returned.
/// ## Example
/// ```rust
/// # use tinyvec::*;
/// let mut av = array_vec!([i32; 7] => 1, 2, 3);
/// let mut av2 = array_vec!([i32; 7] => 4, 5, 6);
/// av.append(&mut av2);
/// assert_eq!(av, &[1, 2, 3, 4, 5, 6][..]);
/// assert_eq!(av2, &[][..]);
///
/// let mut av3 = array_vec!([i32; 7] => 7, 8, 9);
/// assert!(av.try_append(&mut av3).is_some());
/// assert_eq!(av, &[1, 2, 3, 4, 5, 6][..]);
/// assert_eq!(av3, &[7, 8, 9][..]);
/// ```
#[inline]
pub fn try_append<'other>(
&mut self, other: &'other mut Self,
) -> Option<&'other mut Self> {
let new_len = self.len() + other.len();
if new_len > A::CAPACITY {
return Some(other);
}
let iter = other.iter_mut().map(core::mem::take);
for item in iter {
self.push(item);
}
other.set_len(0);
return None;
}
/// A `*mut` pointer to the backing array.
///
/// ## Safety
///
/// This pointer has provenance over the _entire_ backing array.
#[inline(always)]
#[must_use]
pub fn as_mut_ptr(&mut self) -> *mut A::Item {
self.data.as_slice_mut().as_mut_ptr()
}
/// Performs a `deref_mut`, into unique slice form.
#[inline(always)]
#[must_use]
pub fn as_mut_slice(&mut self) -> &mut [A::Item] {
self.deref_mut()
}
/// A `*const` pointer to the backing array.
///
/// ## Safety
///
/// This pointer has provenance over the _entire_ backing array.
#[inline(always)]
#[must_use]
pub fn as_ptr(&self) -> *const A::Item {
self.data.as_slice().as_ptr()
}
/// Performs a `deref`, into shared slice form.
#[inline(always)]
#[must_use]
pub fn as_slice(&self) -> &[A::Item] {
self.deref()
}
/// The capacity of the `ArrayVec`.
///
/// This is fixed based on the array type, but can't yet be made a `const fn`
/// on Stable Rust.
#[inline(always)]
#[must_use]
pub fn capacity(&self) -> usize {
// Note: This shouldn't use A::CAPACITY, because unsafe code can't rely on
// any Array invariants. This ensures that at the very least, the returned
// value is a valid length for a subslice of the backing array.
self.data.as_slice().len().min(u16::MAX as usize)
}
/// Truncates the `ArrayVec` down to length 0.
#[inline(always)]
pub fn clear(&mut self) {
self.truncate(0)
}
/// Creates a draining iterator that removes the specified range in the vector
/// and yields the removed items.
///
/// ## Panics
/// * If the start is greater than the end
/// * If the end is past the edge of the vec.
///
/// ## Example
/// ```rust
/// # use tinyvec::*;
/// let mut av = array_vec!([i32; 4] => 1, 2, 3);
/// let av2: ArrayVec<[i32; 4]> = av.drain(1..).collect();
/// assert_eq!(av.as_slice(), &[1][..]);
/// assert_eq!(av2.as_slice(), &[2, 3][..]);
///
/// av.drain(..);
/// assert_eq!(av.as_slice(), &[]);
/// ```
#[inline]
pub fn drain<R>(&mut self, range: R) -> ArrayVecDrain<'_, A::Item>
where
R: RangeBounds<usize>,
{
ArrayVecDrain::new(self, range)
}
/// Returns the inner array of the `ArrayVec`.
///
/// This returns the full array, even if the `ArrayVec` length is currently
/// less than that.
///
/// ## Example
///
/// ```rust
/// # use tinyvec::{array_vec, ArrayVec};
/// let mut favorite_numbers = array_vec!([i32; 5] => 87, 48, 33, 9, 26);
/// assert_eq!(favorite_numbers.clone().into_inner(), [87, 48, 33, 9, 26]);
///
/// favorite_numbers.pop();
/// assert_eq!(favorite_numbers.into_inner(), [87, 48, 33, 9, 0]);
/// ```
///
/// A use for this function is to build an array from an iterator by first
/// collecting it into an `ArrayVec`.
///
/// ```rust
/// # use tinyvec::ArrayVec;
/// let arr_vec: ArrayVec<[i32; 10]> = (1..=3).cycle().take(10).collect();
/// let inner = arr_vec.into_inner();
/// assert_eq!(inner, [1, 2, 3, 1, 2, 3, 1, 2, 3, 1]);
/// ```
#[inline]
pub fn into_inner(self) -> A {
self.data
}
/// Clone each element of the slice into this `ArrayVec`.
///
/// ## Panics
/// * If the `ArrayVec` would overflow, this will panic.
#[inline]
pub fn extend_from_slice(&mut self, sli: &[A::Item])
where
A::Item: Clone,
{
if sli.is_empty() {
return;
}
let new_len = self.len as usize + sli.len();
assert!(
new_len <= A::CAPACITY,
"ArrayVec::extend_from_slice> total length {} exceeds capacity {}!",
new_len,
A::CAPACITY
);
let target = &mut self.data.as_slice_mut()[self.len as usize..new_len];
target.clone_from_slice(sli);
self.set_len(new_len);
}
/// Fill the vector until its capacity has been reached.
///
/// Successively fills unused space in the spare slice of the vector with
/// elements from the iterator. It then returns the remaining iterator
/// without exhausting it. This also allows appending the head of an
/// infinite iterator.
///
/// This is an alternative to `Extend::extend` method for cases where the
/// length of the iterator can not be checked. Since this vector can not
/// reallocate to increase its capacity, it is unclear what to do with
/// remaining elements in the iterator and the iterator itself. The
/// interface also provides no way to communicate this to the caller.
///
/// ## Panics
/// * If the `next` method of the provided iterator panics.
///
/// ## Example
///
/// ```rust
/// # use tinyvec::*;
/// let mut av = array_vec!([i32; 4]);
/// let mut to_inf = av.fill(0..);
/// assert_eq!(&av[..], [0, 1, 2, 3]);
/// assert_eq!(to_inf.next(), Some(4));
/// ```
#[inline]
pub fn fill<I: IntoIterator<Item = A::Item>>(
&mut self, iter: I,
) -> I::IntoIter {
// If this is written as a call to push for each element in iter, the
// compiler emits code that updates the length for every element. The
// additional complexity from that length update is worth nearly 2x in
// the runtime of this function.
let mut iter = iter.into_iter();
let mut pushed = 0;
let to_take = self.capacity() - self.len();
let target = &mut self.data.as_slice_mut()[self.len as usize..];
for element in iter.by_ref().take(to_take) {
target[pushed] = element;
pushed += 1;
}
self.len += pushed as u16;
iter
}
/// Wraps up an array and uses the given length as the initial length.
///
/// If you want to simply use the full array, use `from` instead.
///
/// ## Panics
///
/// * The length specified must be less than or equal to the capacity of the
/// array.
#[inline]
#[must_use]
#[allow(clippy::match_wild_err_arm)]
pub fn from_array_len(data: A, len: usize) -> Self {
match Self::try_from_array_len(data, len) {
Ok(out) => out,
Err(_) => panic!(
"ArrayVec::from_array_len> length {} exceeds capacity {}!",
len,
A::CAPACITY
),
}
}
/// Inserts an item at the position given, moving all following elements +1
/// index.
///
/// ## Panics
/// * If `index` > `len`
/// * If the capacity is exhausted
///
/// ## Example
/// ```rust
/// use tinyvec::*;
/// let mut av = array_vec!([i32; 10] => 1, 2, 3);
/// av.insert(1, 4);
/// assert_eq!(av.as_slice(), &[1, 4, 2, 3]);
/// av.insert(4, 5);
/// assert_eq!(av.as_slice(), &[1, 4, 2, 3, 5]);
/// ```
#[inline]
pub fn insert(&mut self, index: usize, item: A::Item) {
let x = self.try_insert(index, item);
assert!(x.is_none(), "ArrayVec::insert> capacity overflow!");
}
/// Tries to insert an item at the position given, moving all following
/// elements +1 index.
/// Returns back the element if the capacity is exhausted,
/// otherwise returns None.
///
/// ## Panics
/// * If `index` > `len`
///
/// ## Example
/// ```rust
/// use tinyvec::*;
/// let mut av = array_vec!([&'static str; 4] => "one", "two", "three");
/// av.insert(1, "four");
/// assert_eq!(av.as_slice(), &["one", "four", "two", "three"]);
/// assert_eq!(av.try_insert(4, "five"), Some("five"));
/// ```
#[inline]
pub fn try_insert(
&mut self, index: usize, mut item: A::Item,
) -> Option<A::Item> {
assert!(
index <= self.len as usize,
"ArrayVec::try_insert> index {} is out of bounds {}",
index,
self.len
);
// A previous implementation used self.try_push and slice::rotate_right
// rotate_right and rotate_left generate a huge amount of code and fail to
// inline; calling them here incurs the cost of all the cases they
// handle even though we're rotating a usually-small array by a constant
// 1 offset. This swap-based implementation benchmarks much better for
// small array lengths in particular.
if (self.len as usize) < A::CAPACITY {
self.len += 1;
} else {
return Some(item);
}
let target = &mut self.as_mut_slice()[index..];
#[allow(clippy::needless_range_loop)]
for i in 0..target.len() {
core::mem::swap(&mut item, &mut target[i]);
}
return None;
}
/// Checks if the length is 0.
#[inline(always)]
#[must_use]
pub fn is_empty(&self) -> bool {
self.len == 0
}
/// The length of the `ArrayVec` (in elements).
#[inline(always)]
#[must_use]
pub fn len(&self) -> usize {
self.len as usize
}
/// Makes a new, empty `ArrayVec`.
#[inline(always)]
#[must_use]
pub fn new() -> Self {
Self::default()
}
/// Remove and return the last element of the vec, if there is one.
///
/// ## Failure
/// * If the vec is empty you get `None`.
///
/// ## Example
/// ```rust
/// # use tinyvec::*;
/// let mut av = array_vec!([i32; 10] => 1, 2);
/// assert_eq!(av.pop(), Some(2));
/// assert_eq!(av.pop(), Some(1));
/// assert_eq!(av.pop(), None);
/// ```
#[inline]
pub fn pop(&mut self) -> Option<A::Item> {
if self.len > 0 {
self.len -= 1;
let out =
core::mem::take(&mut self.data.as_slice_mut()[self.len as usize]);
Some(out)
} else {
None
}
}
/// Place an element onto the end of the vec.
///
/// ## Panics
/// * If the length of the vec would overflow the capacity.
///
/// ## Example
/// ```rust
/// # use tinyvec::*;
/// let mut av = array_vec!([i32; 2]);
/// assert_eq!(&av[..], []);
/// av.push(1);
/// assert_eq!(&av[..], [1]);
/// av.push(2);
/// assert_eq!(&av[..], [1, 2]);
/// // av.push(3); this would overflow the ArrayVec and panic!
/// ```
#[inline(always)]
pub fn push(&mut self, val: A::Item) {
let x = self.try_push(val);
assert!(x.is_none(), "ArrayVec::push> capacity overflow!");
}
/// Tries to place an element onto the end of the vec.\
/// Returns back the element if the capacity is exhausted,
/// otherwise returns None.
/// ```rust
/// # use tinyvec::*;
/// let mut av = array_vec!([i32; 2]);
/// assert_eq!(av.as_slice(), []);
/// assert_eq!(av.try_push(1), None);
/// assert_eq!(&av[..], [1]);
/// assert_eq!(av.try_push(2), None);
/// assert_eq!(&av[..], [1, 2]);
/// assert_eq!(av.try_push(3), Some(3));
/// ```
#[inline(always)]
pub fn try_push(&mut self, val: A::Item) -> Option<A::Item> {
debug_assert!(self.len as usize <= A::CAPACITY);
let itemref = match self.data.as_slice_mut().get_mut(self.len as usize) {
None => return Some(val),
Some(x) => x,
};
*itemref = val;
self.len += 1;
return None;
}
/// Removes the item at `index`, shifting all others down by one index.
///
/// Returns the removed element.
///
/// ## Panics
///
/// * If the index is out of bounds.
///
/// ## Example
///
/// ```rust
/// # use tinyvec::*;
/// let mut av = array_vec!([i32; 4] => 1, 2, 3);
/// assert_eq!(av.remove(1), 2);
/// assert_eq!(&av[..], [1, 3]);
/// ```
#[inline]
pub fn remove(&mut self, index: usize) -> A::Item {
let targets: &mut [A::Item] = &mut self.deref_mut()[index..];
let item = core::mem::take(&mut targets[0]);
// A previous implementation used rotate_left
// rotate_right and rotate_left generate a huge amount of code and fail to
// inline; calling them here incurs the cost of all the cases they
// handle even though we're rotating a usually-small array by a constant
// 1 offset. This swap-based implementation benchmarks much better for
// small array lengths in particular.
for i in 0..targets.len() - 1 {
targets.swap(i, i + 1);
}
self.len -= 1;
item
}
/// As [`resize_with`](ArrayVec::resize_with)
/// and it clones the value as the closure.
///
/// ## Example
///
/// ```rust
/// # use tinyvec::*;
///
/// let mut av = array_vec!([&str; 10] => "hello");
/// av.resize(3, "world");
/// assert_eq!(&av[..], ["hello", "world", "world"]);
///
/// let mut av = array_vec!([i32; 10] => 1, 2, 3, 4);
/// av.resize(2, 0);
/// assert_eq!(&av[..], [1, 2]);
/// ```
#[inline]
pub fn resize(&mut self, new_len: usize, new_val: A::Item)
where
A::Item: Clone,
{
self.resize_with(new_len, || new_val.clone())
}
/// Resize the vec to the new length.
///
/// If it needs to be longer, it's filled with repeated calls to the provided
/// function. If it needs to be shorter, it's truncated.
///
/// ## Example
///
/// ```rust
/// # use tinyvec::*;
///
/// let mut av = array_vec!([i32; 10] => 1, 2, 3);
/// av.resize_with(5, Default::default);
/// assert_eq!(&av[..], [1, 2, 3, 0, 0]);
///
/// let mut av = array_vec!([i32; 10]);
/// let mut p = 1;
/// av.resize_with(4, || {
/// p *= 2;
/// p
/// });
/// assert_eq!(&av[..], [2, 4, 8, 16]);
/// ```
#[inline]
pub fn resize_with<F: FnMut() -> A::Item>(
&mut self, new_len: usize, mut f: F,
) {
match new_len.checked_sub(self.len as usize) {
None => self.truncate(new_len),
Some(new_elements) => {
for _ in 0..new_elements {
self.push(f());
}
}
}
}
/// Walk the vec and keep only the elements that pass the predicate given.
///
/// ## Example
///
/// ```rust
/// # use tinyvec::*;
///
/// let mut av = array_vec!([i32; 10] => 1, 1, 2, 3, 3, 4);
/// av.retain(|&x| x % 2 == 0);
/// assert_eq!(&av[..], [2, 4]);
/// ```
#[inline]
pub fn retain<F: FnMut(&A::Item) -> bool>(&mut self, mut acceptable: F) {
// Drop guard to contain exactly the remaining elements when the test
// panics.
struct JoinOnDrop<'vec, Item> {
items: &'vec mut [Item],
done_end: usize,
// Start of tail relative to `done_end`.
tail_start: usize,
}
impl<Item> Drop for JoinOnDrop<'_, Item> {
fn drop(&mut self) {
self.items[self.done_end..].rotate_left(self.tail_start);
}
}
let mut rest = JoinOnDrop {
items: &mut self.data.as_slice_mut()[..self.len as usize],
done_end: 0,
tail_start: 0,
};
let len = self.len as usize;
for idx in 0..len {
// Loop start invariant: idx = rest.done_end + rest.tail_start
if !acceptable(&rest.items[idx]) {
let _ = core::mem::take(&mut rest.items[idx]);
self.len -= 1;
rest.tail_start += 1;
} else {
rest.items.swap(rest.done_end, idx);
rest.done_end += 1;
}
}
}
/// Retains only the elements specified by the predicate, passing a mutable
/// reference to it.
///
/// In other words, remove all elements e such that f(&mut e) returns false.
/// This method operates in place, visiting each element exactly once in the
/// original order, and preserves the order of the retained elements.
///
///
/// ## Example
///
/// ```rust
/// # use tinyvec::*;
///
/// let mut av = array_vec!([i32; 10] => 1, 1, 2, 3, 3, 4);
/// av.retain_mut(|x| if *x % 2 == 0 { *x *= 2; true } else { false });
/// assert_eq!(&av[..], [4, 8]);
/// ```
#[inline]
pub fn retain_mut<F>(&mut self, mut acceptable: F)
where
F: FnMut(&mut A::Item) -> bool,
{
// Drop guard to contain exactly the remaining elements when the test
// panics.
struct JoinOnDrop<'vec, Item> {
items: &'vec mut [Item],
done_end: usize,
// Start of tail relative to `done_end`.
tail_start: usize,
}
impl<Item> Drop for JoinOnDrop<'_, Item> {
fn drop(&mut self) {
self.items[self.done_end..].rotate_left(self.tail_start);
}
}
let mut rest = JoinOnDrop {
items: &mut self.data.as_slice_mut()[..self.len as usize],
done_end: 0,
tail_start: 0,
};
let len = self.len as usize;
for idx in 0..len {
// Loop start invariant: idx = rest.done_end + rest.tail_start
if !acceptable(&mut rest.items[idx]) {
let _ = core::mem::take(&mut rest.items[idx]);
self.len -= 1;
rest.tail_start += 1;
} else {
rest.items.swap(rest.done_end, idx);
rest.done_end += 1;
}
}
}
/// Forces the length of the vector to `new_len`.
///
/// ## Panics
/// * If `new_len` is greater than the vec's capacity.
///
/// ## Safety
/// * This is a fully safe operation! The inactive memory already counts as