[−][src]Struct staticvec::StaticVec

pub struct StaticVec<T, const N: usize> { /* fields omitted */ }

A Vec-like struct (mostly directly API-compatible where it can be) implemented with const generics around an array of fixed N capacity.

Implementations

`impl<T, const N: usize> StaticVec<T, N>`[src]

`pub const fn new() -> Self`[src]

Returns a new StaticVec instance.

Example usage:

let v = StaticVec::<i32, 4>::new();
assert_eq!(v.len(), 0);
assert_eq!(v.capacity(), 4);

`pub fn new_from_slice(values: &[T]) -> Self where T: Copy,` [src]

Returns a new StaticVec instance filled with the contents, if any, of a slice reference, which can be either &mut or & as if it is &mut it will implicitly coerce to &. If the slice has a length greater than the StaticVec's declared capacity, any contents after that point are ignored. Locally requires that T implements Copy to avoid soundness issues.

Example usage:

let v = StaticVec::<i32, 8>::new_from_slice(&[1, 2, 3]);
assert_eq!(v, [1, 2, 3]);

`pub fn new_from_array<const N2: usize>(values: [T; N2]) -> Self`[src]

Returns a new StaticVec instance filled with the contents, if any, of an array. If the array has a length greater than the StaticVec's declared capacity, any contents after that point are ignored.

The N2 parameter does not need to be provided explicitly, and can be inferred from the array itself.

This function does not leak memory, as any ignored extra elements in the source array are explicitly dropped with drop_in_place after it is first wrapped in an instance of MaybeUninit to inhibit the automatic calling of any destructors its contents may have.

Example usage:

// Same input length as the declared capacity:
let v = StaticVec::<i32, 3>::new_from_array([1, 2, 3]);
assert_eq!(v, [1, 2, 3]);
// Truncated to fit the declared capacity:
let v2 = StaticVec::<i32, 3>::new_from_array([1, 2, 3, 4, 5, 6]);
assert_eq!(v2, [1, 2, 3]);

Note that StaticVec also implements From for both slices and static arrays, which may prove more ergonomic in some cases as it allows for a greater degree of type inference:

// The StaticVec on the next line is inferred to be of type `StaticVec<&'static str, 4>`.
let v = StaticVec::from(["A", "B", "C", "D"]);

`pub const fn new_from_const_array(values: [T; N]) -> Self`[src]

A version of new_from_array specifically designed for use as a const fn constructor (although it can of course be used in non-const contexts as well.)

Being const necessitates that this function can only accept arrays with a length exactly equal to the declared capacity of the resulting StaticVec, so if you do need flexibility with regards to input lengths it's recommended that you use new_from_array or the From implementations instead.

Note that both forms of the staticvec! macro are implemented using new_from_const_array, so you may also prefer to use them instead of it directly.

Example usage:

const v: StaticVec<i32, 4> = StaticVec::new_from_const_array([1, 2, 3, 4]);
assert_eq!(v, staticvec![1, 2, 3, 4]);

`pub const fn len(&self) -> usize`[src]

Returns the current length of the StaticVec. Just as for a normal Vec, this means the number of elements that have been added to it with push, insert, etc. except in the case that it has been set directly with the unsafe set_len function.

Example usage:

assert_eq!(staticvec![1].len(), 1);

`pub const fn capacity(&self) -> usize`[src]

Returns the total capacity of the StaticVec. This is always equivalent to the generic N parameter it was declared with, which determines the fixed size of the backing array.

Example usage:

assert_eq!(StaticVec::<usize, 800>::new().capacity(), 800);

`pub const fn cap() -> usize`[src]

Does the same thing as capacity, but as an associated function rather than a method.

Example usage:

assert_eq!(StaticVec::<f64, 12>::cap(), 12)

`pub const CAPACITY: usize`[src]

Serves the same purpose as capacity, but as an associated constant rather than a method.

Example usage:

assert_eq!(StaticVec::<f64, 12>::CAPACITY, 12)

`pub const fn remaining_capacity(&self) -> usize`[src]

Returns the remaining capacity (which is to say, self.capacity() - self.len()) of the StaticVec.

Example usage:

let mut vec = StaticVec::<i32, 100>::new();
vec.push(1);
assert_eq!(vec.remaining_capacity(), 99);

`pub const fn size_in_bytes(&self) -> usize`[src]

Returns the total size of the inhabited part of the StaticVec (which may be zero if it has a length of zero or contains ZSTs) in bytes. Specifically, the return value of this function amounts to a calculation of size_of::<T>() * self.length.

Example usage:

let x = StaticVec::<u8, 8>::from([1, 2, 3, 4, 5, 6, 7, 8]);
assert_eq!(x.size_in_bytes(), 8);
let y = StaticVec::<u16, 8>::from([1, 2, 3, 4, 5, 6, 7, 8]);
assert_eq!(y.size_in_bytes(), 16);
let z = StaticVec::<u32, 8>::from([1, 2, 3, 4, 5, 6, 7, 8]);
assert_eq!(z.size_in_bytes(), 32);
let w = StaticVec::<u64, 8>::from([1, 2, 3, 4, 5, 6, 7, 8]);
assert_eq!(w.size_in_bytes(), 64);

`pub unsafe fn set_len(&mut self, new_len: usize)`[src]

Directly sets the length field of the StaticVec to new_len. Useful if you intend to write to it solely element-wise, but marked unsafe due to how it creates the potential for reading from uninitialized memory later on.

Safety

It is up to the caller to ensure that new_len is less than or equal to the StaticVec's constant N parameter, and that the range of elements covered by a length of new_len is actually initialized. Failure to do so will almost certainly result in undefined behavior.

Example usage:

let mut vec = StaticVec::<i32, 12>::new();
let data = staticvec![1, 2, 3, 4];
unsafe {
  data.as_ptr().copy_to_nonoverlapping(vec.as_mut_ptr(), 4);
  vec.set_len(4);
}
assert_eq!(vec.len(), 4);
assert_eq!(vec.remaining_capacity(), 8);
assert_eq!(vec, data);

`pub const fn is_empty(&self) -> bool`[src]

Returns true if the current length of the StaticVec is 0.

Example usage:

assert!(StaticVec::<i32, 4>::new().is_empty());

`pub const fn is_not_empty(&self) -> bool`[src]

Returns true if the current length of the StaticVec is greater than 0.

Example usage:

assert!(staticvec![staticvec![1, 1], staticvec![2, 2]].is_not_empty());

`pub const fn is_full(&self) -> bool`[src]

Returns true if the current length of the StaticVec is equal to its capacity.

Example usage:

assert!(StaticVec::<i32, 4>::filled_with(|| 2).is_full());

`pub const fn is_not_full(&self) -> bool`[src]

Returns true if the current length of the StaticVec is less than its capacity.

Example usage:

assert!(StaticVec::<i32, 4>::new().is_not_full());

`pub const fn as_ptr(&self) -> *const T`[src]

Returns a constant pointer to the first element of the StaticVec's internal array. It is up to the caller to ensure that the StaticVec lives for as long as they intend to make use of the returned pointer, as once the StaticVec is dropped the pointer will point to uninitialized or "garbage" memory.

Example usage:

let v = staticvec!['A', 'B', 'C'];
let p = v.as_ptr();
unsafe { assert_eq!(*p, 'A') };

`pub const fn as_mut_ptr(&mut self) -> *mut T`[src]

Returns a mutable pointer to the first element of the StaticVec's internal array. It is up to the caller to ensure that the StaticVec lives for as long as they intend to make use of the returned pointer, as once the StaticVec is dropped the pointer will point to uninitialized or "garbage" memory.

Example usage:

let mut v = staticvec!['A', 'B', 'C'];
let p = v.as_mut_ptr();
unsafe { *p = 'X' };
assert_eq!(v, ['X', 'B', 'C']);

`pub const fn as_slice(&self) -> &[T]`[src]

Returns a constant reference to a slice of the StaticVec's inhabited area.

Example usage:

assert_eq!(staticvec![1, 2, 3].as_slice(), &[1, 2, 3]);

`pub const fn as_mut_slice(&mut self) -> &mut [T]`[src]

Returns a mutable reference to a slice of the StaticVec's inhabited area.

Example usage:

let mut v = staticvec![4, 5, 6];
let s = v.as_mut_slice();
s[1] = 9;
assert_eq!(v, [4, 9, 6]);

`pub unsafe fn ptr_at_unchecked(&self, index: usize) -> *const T`[src]

Returns a constant pointer to the element of the StaticVec at index without doing any checking to ensure that index is actually within any particular bounds. The return value of this function is equivalent to what would be returned from as_ptr().add(index).

Safety

It is up to the caller to ensure that index is within the appropriate bounds such that the function returns a pointer to a location that falls somewhere inside the full span of the StaticVec's backing array, and that if reading from the returned pointer, it has already been initialized properly.

Example usage:

let v = staticvec!["I", "am", "a", "StaticVec!"];
unsafe {
  let p = v.ptr_at_unchecked(3);
  assert_eq!(*p, "StaticVec!");
}

`pub unsafe fn mut_ptr_at_unchecked(&mut self, index: usize) -> *mut T`[src]

Returns a mutable pointer to the element of the StaticVec at index without doing any checking to ensure that index is actually within any particular bounds. The return value of this function is equivalent to what would be returned from as_mut_ptr().add(index).

Safety

It is up to the caller to ensure that index is within the appropriate bounds such that the function returns a pointer to a location that falls somewhere inside the full span of the StaticVec's backing array.

It is also the responsibility of the caller to ensure that the length field of the StaticVec is adjusted to properly reflect whatever range of elements this function may be used to initialize, and that if reading from the returned pointer, it has already been initialized properly.

Example usage:

let mut v = staticvec!["I", "am", "not a", "StaticVec!"];
unsafe {
  let p = v.mut_ptr_at_unchecked(2);
  *p = "a";
}
assert_eq!(v, ["I", "am", "a", "StaticVec!"]);

`pub fn ptr_at(&self, index: usize) -> *const T`[src]

Returns a constant pointer to the element of the StaticVec at index if index is within the range 0..self.length, or panics if it is not. The return value of this function is equivalent to what would be returned from as_ptr().add(index).

Example usage:

let v = staticvec!["I", "am", "a", "StaticVec!"];
let p = v.ptr_at(3);
unsafe { assert_eq!(*p, "StaticVec!") };

`pub fn mut_ptr_at(&mut self, index: usize) -> *mut T`[src]

Returns a mutable pointer to the element of the StaticVec at index if index is within the range 0..self.length, or panics if it is not. The return value of this function is equivalent to what would be returned from as_mut_ptr().add(index).

Example usage:

let mut v = staticvec!["I", "am", "not a", "StaticVec!"];
let p = v.mut_ptr_at(2);
unsafe { *p = "a" };
assert_eq!(v, ["I", "am", "a", "StaticVec!"]);

`pub unsafe fn get_unchecked(&self, index: usize) -> &T`[src]

Returns a constant reference to the element of the StaticVec at index without doing any checking to ensure that index is actually within any particular bounds.

Note that unlike slice::get_unchecked, this method only supports accessing individual elements via usize; it cannot also produce subslices. To get a subslice without a bounds check, use self.as_slice().get_unchecked(a..b).

Safety

It is up to the caller to ensure that index is within the range 0..self.length.

Example usage:

unsafe { assert_eq!(*staticvec![1, 2, 3].get_unchecked(1), 2) };

`pub unsafe fn get_unchecked_mut(&mut self, index: usize) -> &mut T`[src]

Returns a mutable reference to the element of the StaticVec at index without doing any checking to ensure that index is actually within any particular bounds.

The same differences between this method and the slice method of the same name apply as do for get_unchecked.

Safety

It is up to the caller to ensure that index is within the range 0..self.length.

Example usage:

let mut v = staticvec![1, 2, 3];
let p = unsafe { v.get_unchecked_mut(1) };
*p = 9;
assert_eq!(v, [1, 9, 3]);

`pub unsafe fn push_unchecked(&mut self, value: T)`[src]

Appends a value to the end of the StaticVec without asserting that its current length is less than N.

Safety

It is up to the caller to ensure that the length of the StaticVec prior to using this function is less than N. Failure to do so will result in writing to an out-of-bounds memory region.

Example usage:

let mut v = StaticVec::<i32, 4>::from([1, 2]);
unsafe { v.push_unchecked(3) };
assert_eq!(v, [1, 2, 3]);

`pub unsafe fn pop_unchecked(&mut self) -> T`[src]

Pops a value from the end of the StaticVec and returns it directly without asserting that the StaticVec's current length is greater than 0.

Safety

It is up to the caller to ensure that the StaticVec contains at least one element prior to using this function. Failure to do so will result in reading from uninitialized memory.

Example usage:

let mut v = StaticVec::<i32, 4>::from([1, 2, 3, 4]);
unsafe { v.pop_unchecked() };
assert_eq!(v, [1, 2, 3]);

`pub fn try_push(&mut self, value: T) -> Result<(), PushCapacityError<T, N>>`[src]

Pushes value to the StaticVec if its current length is less than its capacity, or returns a PushCapacityError otherwise.

Example usage:

let mut v1 = StaticVec::<usize, 128>::filled_with_by_index(|i| i * 4);
assert!(v1.try_push(999).is_err());
let mut v2 = StaticVec::<usize, 128>::new();
assert!(v2.try_push(1).is_ok());

`pub fn push(&mut self, value: T)`[src]

Pushes a value to the end of the StaticVec. Panics if the collection is full; that is, if self.len() == self.capacity().

Example usage:

let mut v = StaticVec::<i32, 8>::new();
v.push(1);
v.push(2);
assert_eq!(v, [1, 2]);

`pub fn pop(&mut self) -> Option<T>`[src]

Removes the value at the last position of the StaticVec and returns it in Some if the StaticVec has a current length greater than 0, and returns None otherwise.

Example usage:

let mut v = staticvec![1, 2, 3, 4];
assert_eq!(v.pop(), Some(4));
assert_eq!(v.pop(), Some(3));
assert_eq!(v, [1, 2]);

`pub fn first(&self) -> Option<&T>`[src]

Returns a constant reference to the first element of the StaticVec in Some if the StaticVec is not empty, or None otherwise.

Example usage:

let v1 = staticvec![10, 40, 30];
assert_eq!(Some(&10), v1.first());
let v2 = StaticVec::<i32, 0>::new();
assert_eq!(None, v2.first());

`pub fn first_mut(&mut self) -> Option<&mut T>`[src]

Returns a mutable reference to the first element of the StaticVec in Some if the StaticVec is not empty, or None otherwise.

Example usage:

let mut x = staticvec![0, 1, 2];
if let Some(first) = x.first_mut() {
  *first = 5;
}
assert_eq!(x, &[5, 1, 2]);

`pub fn last(&self) -> Option<&T>`[src]

Returns a constant reference to the last element of the StaticVec in Some if the StaticVec is not empty, or None otherwise.

Example usage:

let v = staticvec![10, 40, 30];
assert_eq!(Some(&30), v.last());
let w = StaticVec::<i32, 0>::new();
assert_eq!(None, w.last());

`pub fn last_mut(&mut self) -> Option<&mut T>`[src]

Returns a mutable reference to the last element of the StaticVec in Some if the StaticVec is not empty, or None otherwise.

Example usage:

let mut x = staticvec![0, 1, 2];
if let Some(last) = x.last_mut() {
  *last = 10;
}
assert_eq!(x, &[0, 1, 10]);

`pub fn remove(&mut self, index: usize) -> T`[src]

Asserts that index is less than the current length of the StaticVec, and if so removes the value at that position and returns it. Any values that exist in later positions are shifted to the left.

Example usage:

assert_eq!(staticvec![1, 2, 3].remove(1), 2);

`pub fn remove_item(&mut self, item: &T) -> Option<T> where T: PartialEq,` [src]

Removes the first instance of item from the StaticVec if the item exists.

Example usage:

assert_eq!(staticvec![1, 2, 2, 3].remove_item(&2), Some(2));

`pub fn swap_pop(&mut self, index: usize) -> Option<T>`[src]

Returns None if index is greater than or equal to the current length of the StaticVec. Otherwise, removes the value at that position and returns it in Some, and then moves the last value in the StaticVec into the empty slot.

Example usage:

let mut v = staticvec!["AAA", "BBB", "CCC", "DDD"];
assert_eq!(v.swap_pop(1).unwrap(), "BBB");
assert_eq!(v, ["AAA", "DDD", "CCC"]);

`pub fn swap_remove(&mut self, index: usize) -> T`[src]

Asserts that index is less than the current length of the StaticVec, and if so removes the value at that position and returns it, and then moves the last value in the StaticVec into the empty slot.

Example usage:

let mut v = staticvec!["AAA", "BBB", "CCC", "DDD"];
assert_eq!(v.swap_remove(1), "BBB");
assert_eq!(v, ["AAA", "DDD", "CCC"]);

`pub fn insert(&mut self, index: usize, value: T)`[src]

Asserts that the current length of the StaticVec is less than N and that index is less than the length, and if so inserts value at that position. Any values that exist in positions after index are shifted to the right.

Example usage:

let mut v = StaticVec::<i32, 5>::from([1, 2, 3]);
v.insert(1, 4);
assert_eq!(v, [1, 4, 2, 3]);

`pub fn insert_many<I: IntoIterator<Item = T>>(&mut self, index: usize, iter: I) where I::IntoIter: ExactSizeIterator<Item = T>,` [src]

Functionally equivalent to insert, except with multiple items provided by an iterator as opposed to just one. This function will return immediately if / when the StaticVec reaches maximum capacity, regardless of whether the iterator still has more items to yield.

For safety reasons, as StaticVec cannot increase in capacity, the iterator is required to implement ExactSizeIterator rather than just Iterator (though this function still does the appropriate checking internally to avoid dangerous outcomes in the event of a blatantly incorrect ExactSizeIterator implementation.)

Example usage:

let mut v = StaticVec::<usize, 8>::from([1, 2, 3, 4, 7, 8]);
v.insert_many(4, staticvec![5, 6].into_iter());
assert_eq!(v, [1, 2, 3, 4, 5, 6, 7, 8]);

`pub fn try_insert( &mut self, index: usize, value: T ) -> Result<(), CapacityError<N>>`[src]

Inserts value at index if the current length of the StaticVec is less than N and index is less than the length, or returns a CapacityError otherwise. Any values that exist in positions after index are shifted to the right.

Example usage:

let mut vec = StaticVec::<i32, 5>::from([1, 2, 3, 4, 5]);
assert_eq!(vec.try_insert(2, 0), Err(CapacityError::<5> {}));

`pub fn contains(&self, value: &T) -> bool where T: PartialEq,` [src]

Returns true if value is present in the StaticVec. Locally requires that T implements PartialEq to make it possible to compare the elements of the StaticVec with value.

Example usage:

assert_eq!(staticvec![1, 2, 3].contains(&2), true);
assert_eq!(staticvec![1, 2, 3].contains(&4), false);

`pub fn clear(&mut self)`[src]

Removes all contents from the StaticVec and sets its length back to 0.

Example usage:

let mut v = staticvec![1, 2, 3];
assert_eq!(v.len(), 3);
assert_eq!(v, [1, 2, 3]);
v.clear();
assert_eq!(v.len(), 0);
assert_eq!(v, []);

`pub fn iter(&self) -> StaticVecIterConst<T, N>`[src]

Returns a StaticVecIterConst over the StaticVec's inhabited area.

Example usage:

let v = staticvec![4, 3, 2, 1];
for i in v.iter() {
  println!("{}", i);
}

`pub fn iter_mut(&mut self) -> StaticVecIterMut<T, N>`[src]

Returns a StaticVecIterMut over the StaticVec's inhabited area.

Example usage:

let mut v = staticvec![4, 3, 2, 1];
for i in v.iter_mut() {
  *i -= 1;
}
assert_eq!(v, [3, 2, 1, 0]);

`pub fn sorted(&self) -> Self where T: Copy + Ord,` [src]

This is supported on feature="std" only.

Returns a separate, stable-sorted StaticVec of the contents of the StaticVec's inhabited area without modifying the original data. Locally requires that T implements Copy to avoid soundness issues, and Ord to make the sorting possible.

Example usage:

const V: StaticVec<StaticVec<i32, 2>, 2> = staticvec![staticvec![1, 3], staticvec![4, 2]];
assert_eq!(
  V.iter().flatten().collect::<StaticVec<i32, 4>>().sorted(),
  [1, 2, 3, 4]
);

`pub fn sorted_unstable(&self) -> Self where T: Copy + Ord,` [src]

Returns a separate, unstable-sorted StaticVec of the contents of the StaticVec's inhabited area without modifying the original data. Locally requires that T implements Copy to avoid soundness issues, and Ord to make the sorting possible.

Example usage:

const V: StaticVec<StaticVec<i32, 2>, 2> = staticvec![staticvec![1, 3], staticvec![4, 2]];
assert_eq!(
  V.iter().flatten().collect::<StaticVec<i32, 4>>().sorted_unstable(),
  [1, 2, 3, 4]
);

`pub fn quicksorted_unstable(&self) -> Self where T: Copy + PartialOrd,` [src]

Returns a separate, unstable-quicksorted StaticVec of the contents of the StaticVec's inhabited area without modifying the original data. Locally requires that T implements Copy to avoid soundness issues, and PartialOrd to make the sorting possible.

Unlike sorted and sorted_unstable, this function does not make use of Rust's built-in sorting methods, but instead makes direct use of a comparatively unsophisticated recursive quicksort algorithm implemented in this crate.

This has the advantage of only needing to have PartialOrd as a constraint as opposed to Ord, but is very likely less performant for most inputs, so if the type you're sorting does derive or implement Ord it's recommended that you use sorted or sorted_unstable instead of this function.

Example usage:

const V: StaticVec<StaticVec<i32, 2>, 2> = staticvec![staticvec![1, 3], staticvec![4, 2]];
assert_eq!(
  V.iter().flatten().collect::<StaticVec<i32, 4>>().quicksorted_unstable(),
  [1, 2, 3, 4]
);

`pub fn quicksort_unstable(&mut self) where T: Copy + PartialOrd,` [src]

Provides the same sorting functionality as quicksorted_unstable (and has the same trait bound requirements) but operates in-place on the calling StaticVec instance rather than returning the sorted data in a new one.

Example usage:

let mut v = staticvec![5.0, 4.0, 3.0, 2.0, 1.0];
v.quicksort_unstable();
assert_eq!(v, [1.0, 2.0, 3.0, 4.0, 5.0]);
// Note that if you are actually sorting floating-point numbers as shown above, and the
// StaticVec contains one or more instances of NAN, the "accuracy" of the sorting will
// essentially be determined by a combination of how many *consecutive* NANs there are,
// as well as how "mixed up" the surrounding valid numbers were to begin with. In any case,
// the outcome of this particular hypothetical scenario will never be any worse than the
// values simply not being sorted quite as you'd hoped.

`pub fn reversed(&self) -> Self where T: Copy,` [src]

Returns a separate, reversed StaticVec of the contents of the StaticVec's inhabited area without modifying the original data. Locally requires that T implements Copy to avoid soundness issues.

Example usage:

assert_eq!(staticvec![1, 2, 3].reversed(), [3, 2, 1]);

`pub fn filled_with<F>(initializer: F) -> Self where F: FnMut() -> T,` [src]

Returns a new StaticVec instance filled with the return value of an initializer function. The length field of the newly created StaticVec will be equal to its capacity.

Example usage:

let mut i = 0;
let v = StaticVec::<i32, 64>::filled_with(|| { i += 1; i });
assert_eq!(v.len(), 64);
assert_eq!(v[0], 1);
assert_eq!(v[1], 2);
assert_eq!(v[2], 3);
assert_eq!(v[3], 4);

`pub fn filled_with_by_index<F>(initializer: F) -> Self where F: FnMut(usize) -> T,` [src]

Returns a new StaticVec instance filled with the return value of an initializer function. Unlike for filled_with, the initializer function in this case must take a single usize variable as an input parameter, which will be called with the current index of the 0..N loop that filled_with_by_index is implemented with internally. The length field of the newly created StaticVec will be equal to its capacity.

Example usage:

let v = StaticVec::<usize, 64>::filled_with_by_index(|i| { i + 1 });
assert_eq!(v.len(), 64);
assert_eq!(v[0], 1);
assert_eq!(v[1], 2);
assert_eq!(v[2], 3);
assert_eq!(v[3], 4);

`pub fn extend_from_slice(&mut self, other: &[T]) where T: Copy,` [src]

Copies and appends all elements, if any, of a slice (which can also be &mut as it will coerce implicitly to &) to the StaticVec. If the slice has a length greater than the StaticVec's remaining capacity, any contents after that point are ignored. Locally requires that T implements Copy to avoid soundness issues.

Example usage:

let mut v = StaticVec::<i32, 8>::new();
v.extend_from_slice(&[1, 2, 3, 4]);
v.extend_from_slice(&[5, 6, 7, 8, 9, 10, 11]);
assert_eq!(v, [1, 2, 3, 4, 5, 6, 7, 8]);

`pub fn try_extend_from_slice( &mut self, other: &[T] ) -> Result<(), CapacityError<N>> where T: Copy,` [src]

Copies and appends all elements, if any, of a slice to the StaticVec if the StaticVec's remaining capacity is greater than the length of the slice, or returns a CapacityError otherwise.

Example usage:

let mut v = StaticVec::<i32, 8>::new();
assert!(v.try_extend_from_slice(&[1, 2, 3, 4]).is_ok());
assert!(v.try_extend_from_slice(&[5, 6, 7, 8, 9, 10, 11]).is_err());
assert_eq!(v, [1, 2, 3, 4]);

`pub fn append<const N2: usize>(&mut self, other: &mut StaticVec<T, N2>)`[src]

Appends self.remaining_capacity() (or as many as available) items from other to self. The appended items (if any) will no longer exist in other afterwards, as other's length field will be adjusted to indicate.

The N2 parameter does not need to be provided explicitly, and can be inferred directly from the constant N2 constraint of other (which may or may not be the same as the N constraint of self.)

Example usage:

let mut a = StaticVec::<i32, 8>::from([1, 2, 3, 4]);
let mut b = staticvec![1, 2, 3, 4, 5, 6, 7, 8];
a.append(&mut b);
assert_eq!(a.len(), 8);
assert_eq!(a, [1, 2, 3, 4, 1, 2, 3, 4]);
assert_eq!(b, [5, 6, 7, 8]);

`pub fn from_vec(vec: Vec<T>) -> Self`[src]

This is supported on feature="std" only.

Returns a StaticVec containing the contents of a Vec instance. If the Vec has a length greater than the declared capacity of the resulting StaticVec, any contents after that point are ignored. Note that using this function consumes the source Vec.

Example usage:

let mut v = vec![1, 2, 3];
let sv: StaticVec<i32, 3> = StaticVec::from_vec(v);
assert_eq!(sv, [1, 2, 3]);

`pub fn into_vec(self) -> Vec<T>`[src]

This is supported on feature="std" only.

Returns a Vec containing the contents of the StaticVec instance. The returned Vec will initially have the same value for len and capacity as the source StaticVec. Note that using this function consumes the source StaticVec.

Example usage:

let mut sv = staticvec![1, 2, 3];
let v = StaticVec::into_vec(sv);
assert_eq!(v, [1, 2, 3]);

`pub fn into_inner(self) -> Result<[T; N], Self>`[src]

Inspired by the function of the same name from ArrayVec, this function directly returns the StaticVec's backing array (as a "normal" array not wrapped in an instance of MaybeUninit) in Ok if and only if the StaticVec is at maximum capacity. Otherwise, the StaticVec itself is returned in Err.

Example usage:

let mut v1 = StaticVec::<i32, 4>::new();
v1.push(1);
v1.push(2);
let a = v1.into_inner();
assert!(a.is_err());
let v2 = staticvec![1, 2, 3, 4];
let a = v2.into_inner();
assert!(a.is_ok());
assert_eq!(a.unwrap(), [1, 2, 3, 4]);

`pub fn drain<R>(&mut self, range: R) -> Self where R: RangeBounds<usize>,` [src]

Removes the specified range of elements from the StaticVec and returns them in a new one.

Example usage:

let mut v = staticvec![1, 2, 3];
let u = v.drain(1..);
assert_eq!(v, &[1]);

`pub fn drain_iter<R>(&mut self, range: R) -> StaticVecDrain<T, N> where R: RangeBounds<usize>,` [src]

Removes the specified range of elements from the StaticVec and returns them in a StaticVecDrain.

Example usage:

let mut v1 = staticvec![0, 4, 5, 6, 7];
let v2: StaticVec<i32, 3> = v1.drain_iter(1..4).rev().collect();
assert_eq!(v2, [6, 5, 4]);

`pub fn drain_filter<F>(&mut self, filter: F) -> Self where F: FnMut(&mut T) -> bool,` [src]

Removes all elements in the StaticVec for which filter returns true and returns them in a new one.

Example usage:

let mut numbers = staticvec![1, 2, 3, 4, 5, 6, 8, 9, 11, 13, 14, 15];
let evens = numbers.drain_filter(|x| *x % 2 == 0);
let odds = numbers;
assert_eq!(evens, [2, 4, 6, 8, 14]);
assert_eq!(odds, [1, 3, 5, 9, 11, 13, 15]);

`pub fn retain<F>(&mut self, filter: F) where F: FnMut(&T) -> bool,` [src]

Removes all elements in the StaticVec for which filter returns false.

Example usage:

let mut v = staticvec![1, 2, 3, 4, 5];
let keep = staticvec![false, true, true, false, true];
let mut i = 0;
v.retain(|_| (keep[i], i += 1).0);
assert_eq!(v, [2, 3, 5]);

`pub fn truncate(&mut self, length: usize)`[src]

Shortens the StaticVec, keeping the first length elements and dropping the rest. Does nothing if length is greater than or equal to the current length of the StaticVec.

Example usage:

let mut v = staticvec![1, 2, 3, 4, 5];
v.truncate(2);
assert_eq!(v, [1, 2]);

`pub fn split_off(&mut self, at: usize) -> Self`[src]

Splits the StaticVec into two at the given index. The original StaticVec will contain elements 0..at, and the new one will contain elements at..self.len().

Example usage:

let mut v1 = staticvec![1, 2, 3];
let v2 = v1.split_off(1);
assert_eq!(v1, [1]);
assert_eq!(v2, [2, 3]);

`pub fn dedup_by<F>(&mut self, same_bucket: F) where F: FnMut(&mut T, &mut T) -> bool,` [src]

Removes all but the first of consecutive elements in the StaticVec satisfying a given equality relation.

Example usage:

let mut v = staticvec!["aaa", "bbb", "BBB", "ccc", "ddd"];
v.dedup_by(|a, b| a.eq_ignore_ascii_case(b));
assert_eq!(v, ["aaa", "bbb", "ccc", "ddd"]);

`pub fn dedup(&mut self) where T: PartialEq,` [src]

Removes consecutive repeated elements in the StaticVec according to the locally required PartialEq trait implementation for T.

Example usage:

let mut v = staticvec![1, 2, 2, 3, 2];
v.dedup();
assert_eq!(v, [1, 2, 3, 2]);

`pub fn dedup_by_key<F, K>(&mut self, key: F) where F: FnMut(&mut T) -> K, K: PartialEq<K>,` [src]

Removes all but the first of consecutive elements in the StaticVec that resolve to the same key.

Example usage:

let mut v = staticvec![10, 20, 21, 30, 20];
v.dedup_by_key(|i| *i / 10);
assert_eq!(v, [10, 20, 30, 20]);

`pub fn difference<const N2: usize>(&self, other: &StaticVec<T, N2>) -> Self where T: Clone + PartialEq,` [src]

Returns a new StaticVec representing the difference of self and other (that is, all items present in self, but not present in other.)

The N2 parameter does not need to be provided explicitly, and can be inferred from other itself.

Locally requires that T implements Clone to avoid soundness issues while accommodating for more types than Copy would appropriately for this function, and PartialEq to make the item comparisons possible.

Example usage:

assert_eq!(
  staticvec![4, 5, 6, 7].difference(&staticvec![1, 2, 3, 7]),
  [4, 5, 6]
);

`pub fn intersection<const N2: usize>(&self, other: &StaticVec<T, N2>) -> Self where T: Clone + PartialEq,` [src]

Returns a new StaticVec representing the intersection of self and other (that is, all items present in both self and other.)

The N2 parameter does not need to be provided explicitly, and can be inferred from other itself.

Locally requires that T implements Clone to avoid soundness issues while accommodating for more types than Copy would appropriately for this function, and PartialEq to make the item comparisons possible.

Example usage:

assert_eq!(
  staticvec![4, 5, 6, 7].intersection(&staticvec![1, 2, 3, 7, 4]),
  [4, 7],
);

`pub const fn triple(&self) -> (*const T, usize, usize)`[src]

A concept borrowed from the widely-used SmallVec crate, this function returns a tuple consisting of a constant pointer to the first element of the StaticVec, the length of the StaticVec, and the capacity of the StaticVec.

Example usage:

static V: StaticVec<usize, 4> = staticvec![4, 5, 6, 7];
assert_eq!(V.triple(), (V.as_ptr(), 4, 4));

`pub const fn triple_mut(&mut self) -> (*mut T, usize, usize)`[src]

A mutable version of triple. This implementation differs from the one found in SmallVec in that it only provides the first element of the StaticVec as a mutable pointer, not also the length as a mutable reference.

Example:

let mut v = staticvec![4, 5, 6, 7];
let t = v.triple_mut();
assert_eq!(t, (v.as_mut_ptr(), 4, 4));
unsafe { *t.0 = 8 };
assert_eq!(v, [8, 5, 6, 7]);

`pub fn added(&self, other: &Self) -> Self where T: Copy + Add<Output = T>,` [src]

Linearly adds (in a mathematical sense) the contents of two same-capacity StaticVecs and returns the results in a new one of equal capacity.

Locally requires that T implements Copy to allow for an efficient implementation, and Add to make it possible to add the elements.

For both performance and safety reasons, this function requires that both self and other are at full capacity, and will panic if that is not the case (that is, if self.is_full() && other.is_full() is not equal to true.)

Example usage:

const A: StaticVec<f64, 4> = staticvec![4.0, 5.0, 6.0, 7.0];
const B: StaticVec<f64, 4> = staticvec![2.0, 3.0, 4.0, 5.0];
assert_eq!(A.added(&B), [6.0, 8.0, 10.0, 12.0]);

`pub fn subtracted(&self, other: &Self) -> Self where T: Copy + Sub<Output = T>,` [src]

Linearly subtracts (in a mathematical sense) the contents of two same-capacity StaticVecs and returns the results in a new one of equal capacity.

Locally requires that T implements Copy to allow for an efficient implementation, and Sub to make it possible to subtract the elements.

For both performance and safety reasons, this function requires that both self and other are at full capacity, and will panic if that is not the case (that is, if self.is_full() && other.is_full() is not equal to true.)

Example usage:

const A: StaticVec<f64, 4> = staticvec![4.0, 5.0, 6.0, 7.0];
const B: StaticVec<f64, 4> = staticvec![2.0, 3.0, 4.0, 5.0];
assert_eq!(A.subtracted(&B), [2.0, 2.0, 2.0, 2.0]);

`pub fn multiplied(&self, other: &Self) -> Self where T: Copy + Mul<Output = T>,` [src]

Linearly multiplies (in a mathematical sense) the contents of two same-capacity StaticVecs and returns the results in a new one of equal capacity.

Locally requires that T implements Copy to allow for an efficient implementation, and Mul to make it possible to multiply the elements.

For both performance and safety reasons, this function requires that both self and other are at full capacity, and will panic if that is not the case (that is, if self.is_full() && other.is_full() is not equal to true.)

Example usage:

const A: StaticVec<f64, 4> = staticvec![4.0, 5.0, 6.0, 7.0];
const B: StaticVec<f64, 4> = staticvec![2.0, 3.0, 4.0, 5.0];
assert_eq!(A.multiplied(&B), [8.0, 15.0, 24.0, 35.0]);

`pub fn divided(&self, other: &Self) -> Self where T: Copy + Div<Output = T>,` [src]

Linearly divides (in a mathematical sense) the contents of two same-capacity StaticVecs and returns the results in a new one of equal capacity.

Locally requires that T implements Copy to allow for an efficient implementation, and Div to make it possible to divide the elements.

For both performance and safety reasons, this function requires that both self and other are at full capacity, and will panic if that is not the case (that is, if self.is_full() && other.is_full() is not equal to true.)

Example usage:

const A: StaticVec<f64, 4> = staticvec![4.0, 5.0, 6.0, 7.0];
const B: StaticVec<f64, 4> = staticvec![2.0, 3.0, 4.0, 5.0];
assert_eq!(A.divided(&B), [2.0, 1.6666666666666667, 1.5, 1.4]);

Trait Implementations

`impl<T, const N: usize> AsMut<[T]> for StaticVec<T, N>`[src]

`fn as_mut(&mut self) -> &mut [T]`[src]

`impl<T, const N: usize> AsRef<[T]> for StaticVec<T, N>`[src]

`fn as_ref(&self) -> &[T]`[src]

`impl<T, const N: usize> Borrow<[T]> for StaticVec<T, N>`[src]

`fn borrow(&self) -> &[T]`[src]

`impl<T, const N: usize> BorrowMut<[T]> for StaticVec<T, N>`[src]

`fn borrow_mut(&mut self) -> &mut [T]`[src]

`impl<const N: usize> BufRead for StaticVec<u8, N>`[src]

Note: this is only available when the std crate feature is enabled.

`fn fill_buf(&mut self) -> Result<&[u8]>`[src]

`fn consume(&mut self, amt: usize)`[src]

`fn read_until(&mut self, byte: u8, buf: &mut Vec<u8>) -> Result<usize, Error>`1.0.0[src]

`fn read_line(&mut self, buf: &mut String) -> Result<usize, Error>`1.0.0[src]

`fn split(self, byte: u8) -> Split<Self>`1.0.0[src]

`fn lines(self) -> Lines<Self>`1.0.0[src]

`impl<T: Clone, const N: usize> Clone for StaticVec<T, N>`[src]

`default fn clone(&self) -> Self`[src]

`default fn clone_from(&mut self, other: &Self)`[src]

`impl<T: Copy, const N: usize> Clone for StaticVec<T, N>`[src]

`fn clone(&self) -> Self`[src]

`fn clone_from(&mut self, rhs: &Self)`[src]

`impl<T: Debug, const N: usize> Debug for StaticVec<T, N>`[src]

`fn fmt(&self, f: &mut Formatter) -> Result`[src]

`impl<T, const N: usize> Default for StaticVec<T, N>`[src]

`fn default() -> Self`[src]

Calls new.

`impl<T, const N: usize> Deref for StaticVec<T, N>`[src]

`type Target = [T]`

The resulting type after dereferencing.

`fn deref(&self) -> &[T]`[src]

`impl<T, const N: usize> DerefMut for StaticVec<T, N>`[src]

`fn deref_mut(&mut self) -> &mut [T]`[src]

`impl<T, const N: usize> Drop for StaticVec<T, N>`[src]

`fn drop(&mut self)`[src]

`impl<T: Eq, const N: usize> Eq for StaticVec<T, N>`[src]

`impl<'a, T: 'a + Copy, const N: usize> Extend<&'a T> for StaticVec<T, N>`[src]

`fn extend<I: IntoIterator<Item = &'a T>>(&mut self, iter: I)`[src]

`fn extend_one(&mut self, item: A)`[src]

`fn extend_reserve(&mut self, additional: usize)`[src]

`impl<T, const N: usize> Extend<T> for StaticVec<T, N>`[src]

`fn extend<I: IntoIterator<Item = T>>(&mut self, iter: I)`[src]

`fn extend_one(&mut self, item: A)`[src]

`fn extend_reserve(&mut self, additional: usize)`[src]

`impl<'_, T: Copy, const N: usize> From<&'_ [T; N]> for StaticVec<T, N>`[src]

`fn from(values: &[T; N]) -> Self`[src]

Creates a new StaticVec instance from the contents of values, using new_from_slice internally.

`impl<'_, T: Copy, const N1: usize, const N2: usize> From<&'_ [T; N1]> for StaticVec<T, N2>`[src]

`default fn from(values: &[T; N1]) -> Self`[src]

Creates a new StaticVec instance from the contents of values, using new_from_slice internally.

`impl<'_, T: Copy, const N: usize> From<&'_ [T]> for StaticVec<T, N>`[src]

`fn from(values: &[T]) -> Self`[src]

Creates a new StaticVec instance from the contents of values, using new_from_slice internally.

`impl<'_, T: Copy, const N: usize> From<&'_ mut [T; N]> for StaticVec<T, N>`[src]

`fn from(values: &mut [T; N]) -> Self`[src]

Creates a new StaticVec instance from the contents of values, using new_from_slice internally.

`impl<'_, T: Copy, const N1: usize, const N2: usize> From<&'_ mut [T; N1]> for StaticVec<T, N2>`[src]

`default fn from(values: &mut [T; N1]) -> Self`[src]

Creates a new StaticVec instance from the contents of values, using new_from_slice internally.

`impl<'_, T: Copy, const N: usize> From<&'_ mut [T]> for StaticVec<T, N>`[src]

`fn from(values: &mut [T]) -> Self`[src]

Creates a new StaticVec instance from the contents of values, using new_from_slice internally.

`impl<T, const N: usize> From<[T; N]> for StaticVec<T, N>`[src]

`fn from(values: [T; N]) -> Self`[src]

`impl<T, const N1: usize, const N2: usize> From<[T; N1]> for StaticVec<T, N2>`[src]

`default fn from(values: [T; N1]) -> Self`[src]

Creates a new StaticVec instance from the contents of values, using new_from_array internally.

`impl<T, const N: usize> From<StaticHeap<T, N>> for StaticVec<T, N>`[src]

`fn from(heap: StaticHeap<T, N>) -> StaticVec<T, N>`[src]

`impl<T, const N1: usize, const N2: usize> From<StaticHeap<T, N1>> for StaticVec<T, N2>`[src]

`default fn from(heap: StaticHeap<T, N1>) -> StaticVec<T, N2>`[src]

`impl<const N: usize> From<StaticString<N>> for StaticVec<u8, N>`[src]

`fn from(string: StaticString<N>) -> Self`[src]

`impl<const N1: usize, const N2: usize> From<StaticString<N1>> for StaticVec<u8, N2>`[src]

`default fn from(string: StaticString<N1>) -> Self`[src]

`impl<T: Ord, const N: usize> From<StaticVec<T, N>> for StaticHeap<T, N>`[src]

`fn from(vec: StaticVec<T, N>) -> StaticHeap<T, N>`[src]

Converts a StaticVec<T, N> into a StaticHeap<T, N>. This conversion happens in-place, and has O(n) time complexity.

`impl<T: Ord, const N1: usize, const N2: usize> From<StaticVec<T, N1>> for StaticHeap<T, N2>`[src]

`default fn from(vec: StaticVec<T, N1>) -> StaticHeap<T, N2>`[src]

Converts a StaticVec<T, N1> into a StaticHeap<T, N2>. This conversion happens in-place, and has O(n) time complexity.

`impl<const N: usize> From<StaticVec<u8, N>> for StaticString<N>`[src]

`fn from(vec: StaticVec<u8, N>) -> Self`[src]

`impl<const N1: usize, const N2: usize> From<StaticVec<u8, N1>> for StaticString<N2>`[src]

`default fn from(vec: StaticVec<u8, N1>) -> Self`[src]

`impl<T, const N: usize> From<Vec<T>> for StaticVec<T, N>`[src]

Note: this is only available when the std crate feature is enabled.

`fn from(vec: Vec<T>) -> Self`[src]

Functionally equivalent to from_vec.

`impl<'a, T: 'a + Copy, const N: usize> FromIterator<&'a T> for StaticVec<T, N>`[src]

`fn from_iter<I: IntoIterator<Item = &'a T>>(iter: I) -> Self`[src]

`impl<T, const N: usize> FromIterator<T> for StaticVec<T, N>`[src]

`fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Self`[src]

`impl<T: Hash, const N: usize> Hash for StaticVec<T, N>`[src]