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>

pub const fn new() -> Self

Returns a new StaticVec instance.

Example usage:

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

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

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

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 (as well as several other types), 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

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

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

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

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

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

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

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.len().

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 const unsafe fn set_len(&mut self, new_len: usize)

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

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

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

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

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

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

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]

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]

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 const unsafe fn ptr_at_unchecked(&self, index: usize) -> *const T

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 const unsafe fn mut_ptr_at_unchecked(&mut self, index: usize) -> *mut T

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 const fn ptr_at(&self, index: usize) -> *const T

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 const fn mut_ptr_at(&mut self, index: usize) -> *mut T

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 const unsafe fn get_unchecked(&self, index: usize) -> &T

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 const unsafe fn get_unchecked_mut(&mut self, index: usize) -> &mut T

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 const unsafe fn push_unchecked(&mut self, value: T)

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 const unsafe fn pop_unchecked(&mut self) -> T

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 const fn try_push(
    &mut self,
    value: T
) -> Result<(), PushCapacityError<T, N>>

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 const fn push(&mut self, value: T)

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 const fn pop(&mut self) -> Option<T>

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 const fn first(&self) -> Option<&T>

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 const fn first_mut(&mut self) -> Option<&mut T>

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 const fn last(&self) -> Option<&T>

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 const fn last_mut(&mut self) -> Option<&mut T>

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 const fn remove(&mut self, index: usize) -> T

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, 

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>

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

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 const fn insert(&mut self, index: usize, value: T)

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>, 

Functionally equivalent to insert, except with multiple items provided by an iterator as opposed to just one. This function will panic up-front if index is out of bounds or if the StaticVec does not have a sufficient amount of remaining capacity, but once the iteration has started will just 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 const fn insert_from_slice(&mut self, index: usize, values: &[T]) where
    T: Copy, 

Functionally equivalent to insert_many, except with multiple items provided by a slice reference as opposed to an arbitrary iterator. Locally requires that T implements Copy to avoid soundness issues.

Example usage:

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

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

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 const fn try_insert_from_slice(
    &mut self,
    index: usize,
    values: &[T]
) -> Result<(), CapacityError<N>> where
    T: Copy, 

Does the same thing as insert_from_slice, but returns a CapacityError in the event that something goes wrong as opposed to relying on internal assertions.

Example usage:

let mut v1 = StaticVec::<usize, 8>::from([1, 2, 3, 4, 7, 8]);
assert!(v1.try_insert_from_slice(4, &[5, 6]).is_ok());
assert_eq!(v1, [1, 2, 3, 4, 5, 6, 7, 8]);
let mut v2 = StaticVec::<usize, 8>::from([1, 2, 3, 4, 7, 8]);
assert!(v2.try_insert_from_slice(207, &[5, 6]).is_err());

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

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)

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>

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>

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, 

This is supported on crate 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, 

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, 

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, 

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, 

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, 

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, 

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, values: &[T]) where
    T: Copy, 

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,
    values: &[T]
) -> Result<(), CapacityError<N>> where
    T: Copy, 

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>)

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 concat<const N2: usize>(
    &self,
    other: &StaticVec<T, N2>
) -> StaticVec<T, { N + N2 }> where
    T: Copy, 

Returns a new StaticVec consisting of the elements of self and other concatenated in linear fashion such that the first element of other comes immediately after the last element of self.

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.)

Locally requires that T implements Copy to avoid soundness issues and also allow for a more efficient implementation than would otherwise be possible.

Example usage:

assert!(staticvec!['a', 'b'].concat(&staticvec!['c', 'd']) == ['a', 'b', 'c', 'd']);

pub fn concat_clone<const N2: usize>(
    &self,
    other: &StaticVec<T, N2>
) -> StaticVec<T, { N + N2 }> where
    T: Clone, 

A version of concat for scenarios where T does not derive Copy but does implement Clone.

Due to needing to call clone() through each individual element of self and other, this function is less efficient than concat, so concat should be preferred whenever possible.

Example usage:

assert!(staticvec!["a", "b"].concat_clone(&staticvec!["c", "d"]) == ["a", "b", "c", "d"]);

pub const fn intersperse(&self, separator: T) -> StaticVec<T, { N * 2 }> where
    T: Copy, 

Returns a new StaticVec consisting of the elements of self in linear order, interspersed with a copy of separator between each one.

Locally requires that T implements Copy to avoid soundness issues and also allow for a more efficient implementation than would otherwise be possible.

Example usage:

assert_eq!(
 staticvec!["A", "B", "C", "D"].intersperse("Z"),
 ["A", "Z", "B", "Z", "C", "Z", "D"]
);

pub fn intersperse_clone(&self, separator: T) -> StaticVec<T, { N * 2 }> where
    T: Clone, 

A version of intersperse for scenarios where T does not derive Copy but does implement Clone.

Due to needing to call clone() through each individual element of self and also on separator, this function is less efficient than intersperse, so intersperse should be preferred whenever possible.

Example usage:

assert_eq!(
 staticvec!["A", "B", "C", "D"].intersperse_clone("Z"),
 ["A", "Z", "B", "Z", "C", "Z", "D"]
);

pub fn from_vec(vec: Vec<T>) -> Self

This is supported on crate 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>

This is supported on crate 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 = sv.into_vec();
assert_eq!(v, [1, 2, 3]);

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

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>, 

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

Panics

Panics if the range’s starting point is greater than the end point or if the end point is greater than the length of the StaticVec.

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>, 

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

Panics

Panics if the range’s starting point is greater than the end point or if the end point is greater than the length of the StaticVec.

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, 

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 splice<R, I>(
    &mut self,
    range: R,
    replace_with: I
) -> StaticVecSplice<T, I::IntoIter, N> where
    R: RangeBounds<usize>,
    I: IntoIterator<Item = T>, 

Replaces the specified range in the StaticVec with the contents of replace_with and returns the removed items in an instance of StaticVecSplice. replace_with does not need to be the same length as range. Returns immediately if and when the StaticVec reaches maximum capacity, regardless of whether or not replace_with still has more items to yield.

Panics

Panics if the range’s starting point is greater than the end point or if the end point is greater than the length of the StaticVec.

Example usage:

let mut v = staticvec![1, 2, 3];
let new = [7, 8];
let u: StaticVec<u8, 2> = v.splice(..2, new.iter().copied()).collect();
assert_eq!(v, [7, 8, 3]);
assert_eq!(u, [1, 2]);

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

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)

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

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, 

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, 

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>, 

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, 

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 symmetric_difference<const N2: usize>(
    &self,
    other: &StaticVec<T, N2>
) -> StaticVec<T, { N + N2 }> where
    T: Clone + PartialEq, 

Returns a new StaticVec representing the symmetric difference of self and other (that is, all items present in at least one of self or other, but not present in both.)

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![1, 2, 3].symmetric_difference(&staticvec![3, 4, 5]),
  [1, 2, 4, 5]
);

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

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 fn union<const N2: usize>(
    &self,
    other: &StaticVec<T, N2>
) -> StaticVec<T, { N + N2 }> where
    T: Clone + PartialEq, 

Returns a new StaticVec representing the union of self and other (that is, the full contents of both self and other, minus any duplicates.)

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![1, 2, 3].union(&staticvec![4, 2, 3, 4]),
  [1, 2, 3, 4],
);

pub const fn triple(&self) -> (*const T, usize, usize)

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)

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>, 

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>, 

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>, 

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>, 

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]);

Methods from Deref<Target = [T]>

pub fn len(&self) -> usize

Returns the number of elements in the slice.

Examples

let a = [1, 2, 3];
assert_eq!(a.len(), 3);

pub fn is_empty(&self) -> bool

Returns true if the slice has a length of 0.

Examples

let a = [1, 2, 3];
assert!(!a.is_empty());

pub fn first(&self) -> Option<&T>

Returns the first element of the slice, or None if it is empty.

Examples

let v = [10, 40, 30];
assert_eq!(Some(&10), v.first());

let w: &[i32] = &[];
assert_eq!(None, w.first());

pub fn first_mut(&mut self) -> Option<&mut T>

Returns a mutable pointer to the first element of the slice, or None if it is empty.

Examples

let x = &mut [0, 1, 2];

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

pub fn split_first(&self) -> Option<(&T, &[T])>

Returns the first and all the rest of the elements of the slice, or None if it is empty.

Examples

let x = &[0, 1, 2];

if let Some((first, elements)) = x.split_first() {
    assert_eq!(first, &0);
    assert_eq!(elements, &[1, 2]);
}

pub fn split_first_mut(&mut self) -> Option<(&mut T, &mut [T])>

Returns the first and all the rest of the elements of the slice, or None if it is empty.

Examples

let x = &mut [0, 1, 2];

if let Some((first, elements)) = x.split_first_mut() {
    *first = 3;
    elements[0] = 4;
    elements[1] = 5;
}
assert_eq!(x, &[3, 4, 5]);

pub fn split_last(&self) -> Option<(&T, &[T])>

Returns the last and all the rest of the elements of the slice, or None if it is empty.

Examples

let x = &[0, 1, 2];

if let Some((last, elements)) = x.split_last() {
    assert_eq!(last, &2);
    assert_eq!(elements, &[0, 1]);
}

pub fn split_last_mut(&mut self) -> Option<(&mut T, &mut [T])>

Returns the last and all the rest of the elements of the slice, or None if it is empty.

Examples

let x = &mut [0, 1, 2];

if let Some((last, elements)) = x.split_last_mut() {
    *last = 3;
    elements[0] = 4;
    elements[1] = 5;
}
assert_eq!(x, &[4, 5, 3]);

pub fn last(&self) -> Option<&T>

Returns the last element of the slice, or None if it is empty.

Examples

let v = [10, 40, 30];
assert_eq!(Some(&30), v.last());

let w: &[i32] = &[];
assert_eq!(None, w.last());

pub fn last_mut(&mut self) -> Option<&mut T>

Returns a mutable pointer to the last item in the slice.

Examples

let x = &mut [0, 1, 2];

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

pub fn get<I>(&self, index: I) -> Option<&<I as SliceIndex<[T]>>::Output> where
    I: SliceIndex<[T]>, 

Returns a reference to an element or subslice depending on the type of index.

• If given a position, returns a reference to the element at that position or None if out of bounds.
• If given a range, returns the subslice corresponding to that range, or None if out of bounds.

Examples

let v = [10, 40, 30];
assert_eq!(Some(&40), v.get(1));
assert_eq!(Some(&[10, 40][..]), v.get(0..2));
assert_eq!(None, v.get(3));
assert_eq!(None, v.get(0..4));

pub fn get_mut<I>(
    &mut self,
    index: I
) -> Option<&mut <I as SliceIndex<[T]>>::Output> where
    I: SliceIndex<[T]>, 

Returns a mutable reference to an element or subslice depending on the type of index (see get) or None if the index is out of bounds.

Examples

let x = &mut [0, 1, 2];

if let Some(elem) = x.get_mut(1) {
    *elem = 42;
}
assert_eq!(x, &[0, 42, 2]);

pub unsafe fn get_unchecked<I>(
    &self,
    index: I
) -> &<I as SliceIndex<[T]>>::Output where
    I: SliceIndex<[T]>, 

Returns a reference to an element or subslice, without doing bounds checking.

For a safe alternative see get.

Safety

Calling this method with an out-of-bounds index is undefined behavior even if the resulting reference is not used.

Examples

let x = &[1, 2, 4];

unsafe {
    assert_eq!(x.get_unchecked(1), &2);
}

pub unsafe fn get_unchecked_mut<I>(
    &mut self,
    index: I
) -> &mut <I as SliceIndex<[T]>>::Output where
    I: SliceIndex<[T]>, 

Returns a mutable reference to an element or subslice, without doing bounds checking.

For a safe alternative see get_mut.

Safety

Calling this method with an out-of-bounds index is undefined behavior even if the resulting reference is not used.

Examples

let x = &mut [1, 2, 4];

unsafe {
    let elem = x.get_unchecked_mut(1);
    *elem = 13;
}
assert_eq!(x, &[1, 13, 4]);

pub fn as_ptr(&self) -> *const T

Returns a raw pointer to the slice’s buffer.

The caller must ensure that the slice outlives the pointer this function returns, or else it will end up pointing to garbage.

The caller must also ensure that the memory the pointer (non-transitively) points to is never written to (except inside an UnsafeCell) using this pointer or any pointer derived from it. If you need to mutate the contents of the slice, use as_mut_ptr.

Modifying the container referenced by this slice may cause its buffer to be reallocated, which would also make any pointers to it invalid.

Examples

let x = &[1, 2, 4];
let x_ptr = x.as_ptr();

unsafe {
    for i in 0..x.len() {
        assert_eq!(x.get_unchecked(i), &*x_ptr.add(i));
    }
}

pub fn as_mut_ptr(&mut self) -> *mut T

Returns an unsafe mutable pointer to the slice’s buffer.

The caller must ensure that the slice outlives the pointer this function returns, or else it will end up pointing to garbage.

Modifying the container referenced by this slice may cause its buffer to be reallocated, which would also make any pointers to it invalid.

Examples

let x = &mut [1, 2, 4];
let x_ptr = x.as_mut_ptr();

unsafe {
    for i in 0..x.len() {
        *x_ptr.add(i) += 2;
    }
}
assert_eq!(x, &[3, 4, 6]);

pub fn as_ptr_range(&self) -> Range<*const T>

Returns the two raw pointers spanning the slice.

The returned range is half-open, which means that the end pointer points one past the last element of the slice. This way, an empty slice is represented by two equal pointers, and the difference between the two pointers represents the size of the slice.

See as_ptr for warnings on using these pointers. The end pointer requires extra caution, as it does not point to a valid element in the slice.

This function is useful for interacting with foreign interfaces which use two pointers to refer to a range of elements in memory, as is common in C++.

It can also be useful to check if a pointer to an element refers to an element of this slice:

let a = [1, 2, 3];
let x = &a[1] as *const _;
let y = &5 as *const _;

assert!(a.as_ptr_range().contains(&x));
assert!(!a.as_ptr_range().contains(&y));

pub fn as_mut_ptr_range(&mut self) -> Range<*mut T>

Returns the two unsafe mutable pointers spanning the slice.

The returned range is half-open, which means that the end pointer points one past the last element of the slice. This way, an empty slice is represented by two equal pointers, and the difference between the two pointers represents the size of the slice.

See as_mut_ptr for warnings on using these pointers. The end pointer requires extra caution, as it does not point to a valid element in the slice.

This function is useful for interacting with foreign interfaces which use two pointers to refer to a range of elements in memory, as is common in C++.

pub fn swap(&mut self, a: usize, b: usize)

Swaps two elements in the slice.

Arguments

• a - The index of the first element
• b - The index of the second element

Panics

Panics if a or b are out of bounds.

Examples

let mut v = ["a", "b", "c", "d"];
v.swap(1, 3);
assert!(v == ["a", "d", "c", "b"]);

pub fn reverse(&mut self)

Reverses the order of elements in the slice, in place.

Examples

let mut v = [1, 2, 3];
v.reverse();
assert!(v == [3, 2, 1]);

pub fn iter(&self) -> Iter<'_, T>

Returns an iterator over the slice.

Examples

let x = &[1, 2, 4];
let mut iterator = x.iter();

assert_eq!(iterator.next(), Some(&1));
assert_eq!(iterator.next(), Some(&2));
assert_eq!(iterator.next(), Some(&4));
assert_eq!(iterator.next(), None);

pub fn iter_mut(&mut self) -> IterMut<'_, T>

Returns an iterator that allows modifying each value.

Examples

let x = &mut [1, 2, 4];
for elem in x.iter_mut() {
    *elem += 2;
}
assert_eq!(x, &[3, 4, 6]);

pub fn windows(&self, size: usize) -> Windows<'_, T>

Returns an iterator over all contiguous windows of length size. The windows overlap. If the slice is shorter than size, the iterator returns no values.

Panics

Panics if size is 0.

Examples

let slice = ['r', 'u', 's', 't'];
let mut iter = slice.windows(2);
assert_eq!(iter.next().unwrap(), &['r', 'u']);
assert_eq!(iter.next().unwrap(), &['u', 's']);
assert_eq!(iter.next().unwrap(), &['s', 't']);
assert!(iter.next().is_none());

If the slice is shorter than size:

let slice = ['f', 'o', 'o'];
let mut iter = slice.windows(4);
assert!(iter.next().is_none());

pub fn chunks(&self, chunk_size: usize) -> Chunks<'_, T>

Returns an iterator over chunk_size elements of the slice at a time, starting at the beginning of the slice.

The chunks are slices and do not overlap. If chunk_size does not divide the length of the slice, then the last chunk will not have length chunk_size.

See chunks_exact for a variant of this iterator that returns chunks of always exactly chunk_size elements, and rchunks for the same iterator but starting at the end of the slice.

Panics

Panics if chunk_size is 0.

Examples

let slice = ['l', 'o', 'r', 'e', 'm'];
let mut iter = slice.chunks(2);
assert_eq!(iter.next().unwrap(), &['l', 'o']);
assert_eq!(iter.next().unwrap(), &['r', 'e']);
assert_eq!(iter.next().unwrap(), &['m']);
assert!(iter.next().is_none());

pub fn chunks_mut(&mut self, chunk_size: usize) -> ChunksMut<'_, T>

Returns an iterator over chunk_size elements of the slice at a time, starting at the beginning of the slice.

The chunks are mutable slices, and do not overlap. If chunk_size does not divide the length of the slice, then the last chunk will not have length chunk_size.

See chunks_exact_mut for a variant of this iterator that returns chunks of always exactly chunk_size elements, and rchunks_mut for the same iterator but starting at the end of the slice.

Panics

Panics if chunk_size is 0.

Examples

let v = &mut [0, 0, 0, 0, 0];
let mut count = 1;

for chunk in v.chunks_mut(2) {
    for elem in chunk.iter_mut() {
        *elem += count;
    }
    count += 1;
}
assert_eq!(v, &[1, 1, 2, 2, 3]);

pub fn chunks_exact(&self, chunk_size: usize) -> ChunksExact<'_, T>

Returns an iterator over chunk_size elements of the slice at a time, starting at the beginning of the slice.

The chunks are slices and do not overlap. If chunk_size does not divide the length of the slice, then the last up to chunk_size-1 elements will be omitted and can be retrieved from the remainder function of the iterator.

Due to each chunk having exactly chunk_size elements, the compiler can often optimize the resulting code better than in the case of chunks.

See chunks for a variant of this iterator that also returns the remainder as a smaller chunk, and rchunks_exact for the same iterator but starting at the end of the slice.

Panics

Panics if chunk_size is 0.

Examples

let slice = ['l', 'o', 'r', 'e', 'm'];
let mut iter = slice.chunks_exact(2);
assert_eq!(iter.next().unwrap(), &['l', 'o']);
assert_eq!(iter.next().unwrap(), &['r', 'e']);
assert!(iter.next().is_none());
assert_eq!(iter.remainder(), &['m']);

pub fn chunks_exact_mut(&mut self, chunk_size: usize) -> ChunksExactMut<'_, T>

Returns an iterator over chunk_size elements of the slice at a time, starting at the beginning of the slice.

The chunks are mutable slices, and do not overlap. If chunk_size does not divide the length of the slice, then the last up to chunk_size-1 elements will be omitted and can be retrieved from the into_remainder function of the iterator.

Due to each chunk having exactly chunk_size elements, the compiler can often optimize the resulting code better than in the case of chunks_mut.

See chunks_mut for a variant of this iterator that also returns the remainder as a smaller chunk, and rchunks_exact_mut for the same iterator but starting at the end of the slice.

Panics

Panics if chunk_size is 0.

Examples

let v = &mut [0, 0, 0, 0, 0];
let mut count = 1;

for chunk in v.chunks_exact_mut(2) {
    for elem in chunk.iter_mut() {
        *elem += count;
    }
    count += 1;
}
assert_eq!(v, &[1, 1, 2, 2, 0]);

pub unsafe fn as_chunks_unchecked<const N: usize>(&self) -> &[[T; N]]

🔬 This is a nightly-only experimental API. (slice_as_chunks)

Splits the slice into a slice of N-element arrays, assuming that there’s no remainder.

Safety

This may only be called when

• The slice splits exactly into N-element chunks (aka self.len() % N == 0).
• N != 0.

Examples

#![feature(slice_as_chunks)]
let slice: &[char] = &['l', 'o', 'r', 'e', 'm', '!'];
let chunks: &[[char; 1]] =
    // SAFETY: 1-element chunks never have remainder
    unsafe { slice.as_chunks_unchecked() };
assert_eq!(chunks, &[['l'], ['o'], ['r'], ['e'], ['m'], ['!']]);
let chunks: &[[char; 3]] =
    // SAFETY: The slice length (6) is a multiple of 3
    unsafe { slice.as_chunks_unchecked() };
assert_eq!(chunks, &[['l', 'o', 'r'], ['e', 'm', '!']]);

// These would be unsound:
// let chunks: &[[_; 5]] = slice.as_chunks_unchecked() // The slice length is not a multiple of 5
// let chunks: &[[_; 0]] = slice.as_chunks_unchecked() // Zero-length chunks are never allowed

pub fn as_chunks<const N: usize>(&self) -> (&[[T; N]], &[T])

🔬 This is a nightly-only experimental API. (slice_as_chunks)

Splits the slice into a slice of N-element arrays, starting at the beginning of the slice, and a remainder slice with length strictly less than N.

Panics

Panics if N is 0. This check will most probably get changed to a compile time error before this method gets stabilized.

Examples

#![feature(slice_as_chunks)]
let slice = ['l', 'o', 'r', 'e', 'm'];
let (chunks, remainder) = slice.as_chunks();
assert_eq!(chunks, &[['l', 'o'], ['r', 'e']]);
assert_eq!(remainder, &['m']);

pub fn as_rchunks<const N: usize>(&self) -> (&[T], &[[T; N]])

🔬 This is a nightly-only experimental API. (slice_as_chunks)

Splits the slice into a slice of N-element arrays, starting at the end of the slice, and a remainder slice with length strictly less than N.

Panics

Panics if N is 0. This check will most probably get changed to a compile time error before this method gets stabilized.

Examples

#![feature(slice_as_chunks)]
let slice = ['l', 'o', 'r', 'e', 'm'];
let (remainder, chunks) = slice.as_rchunks();
assert_eq!(remainder, &['l']);
assert_eq!(chunks, &[['o', 'r'], ['e', 'm']]);

pub fn array_chunks<const N: usize>(&self) -> ArrayChunks<'_, T, N>

🔬 This is a nightly-only experimental API. (array_chunks)

Returns an iterator over N elements of the slice at a time, starting at the beginning of the slice.

The chunks are array references and do not overlap. If N does not divide the length of the slice, then the last up to N-1 elements will be omitted and can be retrieved from the remainder function of the iterator.

This method is the const generic equivalent of chunks_exact.

Panics

Panics if N is 0. This check will most probably get changed to a compile time error before this method gets stabilized.

Examples

#![feature(array_chunks)]
let slice = ['l', 'o', 'r', 'e', 'm'];
let mut iter = slice.array_chunks();
assert_eq!(iter.next().unwrap(), &['l', 'o']);
assert_eq!(iter.next().unwrap(), &['r', 'e']);
assert!(iter.next().is_none());
assert_eq!(iter.remainder(), &['m']);

pub unsafe fn as_chunks_unchecked_mut<const N: usize>(
    &mut self
) -> &mut [[T; N]]

🔬 This is a nightly-only experimental API. (slice_as_chunks)

Splits the slice into a slice of N-element arrays, assuming that there’s no remainder.

Safety

This may only be called when

• The slice splits exactly into N-element chunks (aka self.len() % N == 0).
• N != 0.

Examples

#![feature(slice_as_chunks)]
let slice: &mut [char] = &mut ['l', 'o', 'r', 'e', 'm', '!'];
let chunks: &mut [[char; 1]] =
    // SAFETY: 1-element chunks never have remainder
    unsafe { slice.as_chunks_unchecked_mut() };
chunks[0] = ['L'];
assert_eq!(chunks, &[['L'], ['o'], ['r'], ['e'], ['m'], ['!']]);
let chunks: &mut [[char; 3]] =
    // SAFETY: The slice length (6) is a multiple of 3
    unsafe { slice.as_chunks_unchecked_mut() };
chunks[1] = ['a', 'x', '?'];
assert_eq!(slice, &['L', 'o', 'r', 'a', 'x', '?']);

// These would be unsound:
// let chunks: &[[_; 5]] = slice.as_chunks_unchecked_mut() // The slice length is not a multiple of 5
// let chunks: &[[_; 0]] = slice.as_chunks_unchecked_mut() // Zero-length chunks are never allowed

pub fn as_chunks_mut<const N: usize>(&mut self) -> (&mut [[T; N]], &mut [T])

🔬 This is a nightly-only experimental API. (slice_as_chunks)

Splits the slice into a slice of N-element arrays, starting at the beginning of the slice, and a remainder slice with length strictly less than N.

Panics

Panics if N is 0. This check will most probably get changed to a compile time error before this method gets stabilized.

Examples

#![feature(slice_as_chunks)]
let v = &mut [0, 0, 0, 0, 0];
let mut count = 1;

let (chunks, remainder) = v.as_chunks_mut();
remainder[0] = 9;
for chunk in chunks {
    *chunk = [count; 2];
    count += 1;
}
assert_eq!(v, &[1, 1, 2, 2, 9]);

pub fn as_rchunks_mut<const N: usize>(&mut self) -> (&mut [T], &mut [[T; N]])

🔬 This is a nightly-only experimental API. (slice_as_chunks)

Splits the slice into a slice of N-element arrays, starting at the end of the slice, and a remainder slice with length strictly less than N.

Panics

Panics if N is 0. This check will most probably get changed to a compile time error before this method gets stabilized.

Examples

#![feature(slice_as_chunks)]
let v = &mut [0, 0, 0, 0, 0];
let mut count = 1;

let (remainder, chunks) = v.as_rchunks_mut();
remainder[0] = 9;
for chunk in chunks {
    *chunk = [count; 2];
    count += 1;
}
assert_eq!(v, &[9, 1, 1, 2, 2]);

pub fn array_chunks_mut<const N: usize>(&mut self) -> ArrayChunksMut<'_, T, N>

🔬 This is a nightly-only experimental API. (array_chunks)

Returns an iterator over N elements of the slice at a time, starting at the beginning of the slice.

The chunks are mutable array references and do not overlap. If N does not divide the length of the slice, then the last up to N-1 elements will be omitted and can be retrieved from the into_remainder function of the iterator.

This method is the const generic equivalent of chunks_exact_mut.

Panics

Panics if N is 0. This check will most probably get changed to a compile time error before this method gets stabilized.

Examples

#![feature(array_chunks)]
let v = &mut [0, 0, 0, 0, 0];
let mut count = 1;

for chunk in v.array_chunks_mut() {
    *chunk = [count; 2];
    count += 1;
}
assert_eq!(v, &[1, 1, 2, 2, 0]);

pub fn array_windows<const N: usize>(&self) -> ArrayWindows<'_, T, N>

🔬 This is a nightly-only experimental API. (array_windows)

Returns an iterator over overlapping windows of N elements of a slice, starting at the beginning of the slice.

This is the const generic equivalent of windows.

If N is greater than the size of the slice, it will return no windows.

Panics

Panics if N is 0. This check will most probably get changed to a compile time error before this method gets stabilized.

Examples

#![feature(array_windows)]
let slice = [0, 1, 2, 3];
let mut iter = slice.array_windows();
assert_eq!(iter.next().unwrap(), &[0, 1]);
assert_eq!(iter.next().unwrap(), &[1, 2]);
assert_eq!(iter.next().unwrap(), &[2, 3]);
assert!(iter.next().is_none());

pub fn rchunks(&self, chunk_size: usize) -> RChunks<'_, T>

Returns an iterator over chunk_size elements of the slice at a time, starting at the end of the slice.

The chunks are slices and do not overlap. If chunk_size does not divide the length of the slice, then the last chunk will not have length chunk_size.

See rchunks_exact for a variant of this iterator that returns chunks of always exactly chunk_size elements, and chunks for the same iterator but starting at the beginning of the slice.

Panics

Panics if chunk_size is 0.

Examples

let slice = ['l', 'o', 'r', 'e', 'm'];
let mut iter = slice.rchunks(2);
assert_eq!(iter.next().unwrap(), &['e', 'm']);
assert_eq!(iter.next().unwrap(), &['o', 'r']);
assert_eq!(iter.next().unwrap(), &['l']);
assert!(iter.next().is_none());

pub fn rchunks_mut(&mut self, chunk_size: usize) -> RChunksMut<'_, T>

Returns an iterator over chunk_size elements of the slice at a time, starting at the end of the slice.

The chunks are mutable slices, and do not overlap. If chunk_size does not divide the length of the slice, then the last chunk will not have length chunk_size.

See rchunks_exact_mut for a variant of this iterator that returns chunks of always exactly chunk_size elements, and chunks_mut for the same iterator but starting at the beginning of the slice.

Panics

Panics if chunk_size is 0.

Examples

let v = &mut [0, 0, 0, 0, 0];
let mut count = 1;

for chunk in v.rchunks_mut(2) {
    for elem in chunk.iter_mut() {
        *elem += count;
    }
    count += 1;
}
assert_eq!(v, &[3, 2, 2, 1, 1]);

pub fn rchunks_exact(&self, chunk_size: usize) -> RChunksExact<'_, T>

Returns an iterator over chunk_size elements of the slice at a time, starting at the end of the slice.

The chunks are slices and do not overlap. If chunk_size does not divide the length of the slice, then the last up to chunk_size-1 elements will be omitted and can be retrieved from the remainder function of the iterator.

Due to each chunk having exactly chunk_size elements, the compiler can often optimize the resulting code better than in the case of chunks.

See rchunks for a variant of this iterator that also returns the remainder as a smaller chunk, and chunks_exact for the same iterator but starting at the beginning of the slice.

Panics

Panics if chunk_size is 0.

Examples

let slice = ['l', 'o', 'r', 'e', 'm'];
let mut iter = slice.rchunks_exact(2);
assert_eq!(iter.next().unwrap(), &['e', 'm']);
assert_eq!(iter.next().unwrap(), &['o', 'r']);
assert!(iter.next().is_none());
assert_eq!(iter.remainder(), &['l']);

pub fn rchunks_exact_mut(&mut self, chunk_size: usize) -> RChunksExactMut<'_, T>

Returns an iterator over chunk_size elements of the slice at a time, starting at the end of the slice.

The chunks are mutable slices, and do not overlap. If chunk_size does not divide the length of the slice, then the last up to chunk_size-1 elements will be omitted and can be retrieved from the into_remainder function of the iterator.

Due to each chunk having exactly chunk_size elements, the compiler can often optimize the resulting code better than in the case of chunks_mut.

See rchunks_mut for a variant of this iterator that also returns the remainder as a smaller chunk, and chunks_exact_mut for the same iterator but starting at the beginning of the slice.

Panics

Panics if chunk_size is 0.

Examples

let v = &mut [0, 0, 0, 0, 0];
let mut count = 1;

for chunk in v.rchunks_exact_mut(2) {
    for elem in chunk.iter_mut() {
        *elem += count;
    }
    count += 1;
}
assert_eq!(v, &[0, 2, 2, 1, 1]);

pub fn group_by<F>(&self, pred: F) -> GroupBy<'_, T, F> where
    F: FnMut(&T, &T) -> bool, 

🔬 This is a nightly-only experimental API. (slice_group_by)

Returns an iterator over the slice producing non-overlapping runs of elements using the predicate to separate them.

The predicate is called on two elements following themselves, it means the predicate is called on slice[0] and slice[1] then on slice[1] and slice[2] and so on.

Examples

#![feature(slice_group_by)]

let slice = &[1, 1, 1, 3, 3, 2, 2, 2];

let mut iter = slice.group_by(|a, b| a == b);

assert_eq!(iter.next(), Some(&[1, 1, 1][..]));
assert_eq!(iter.next(), Some(&[3, 3][..]));
assert_eq!(iter.next(), Some(&[2, 2, 2][..]));
assert_eq!(iter.next(), None);

This method can be used to extract the sorted subslices:

#![feature(slice_group_by)]

let slice = &[1, 1, 2, 3, 2, 3, 2, 3, 4];

let mut iter = slice.group_by(|a, b| a <= b);

assert_eq!(iter.next(), Some(&[1, 1, 2, 3][..]));
assert_eq!(iter.next(), Some(&[2, 3][..]));
assert_eq!(iter.next(), Some(&[2, 3, 4][..]));
assert_eq!(iter.next(), None);

pub fn group_by_mut<F>(&mut self, pred: F) -> GroupByMut<'_, T, F> where
    F: FnMut(&T, &T) -> bool, 

🔬 This is a nightly-only experimental API. (slice_group_by)

Returns an iterator over the slice producing non-overlapping mutable runs of elements using the predicate to separate them.

The predicate is called on two elements following themselves, it means the predicate is called on slice[0] and slice[1] then on slice[1] and slice[2] and so on.

Examples

#![feature(slice_group_by)]

let slice = &mut [1, 1, 1, 3, 3, 2, 2, 2];

let mut iter = slice.group_by_mut(|a, b| a == b);

assert_eq!(iter.next(), Some(&mut [1, 1, 1][..]));
assert_eq!(iter.next(), Some(&mut [3, 3][..]));
assert_eq!(iter.next(), Some(&mut [2, 2, 2][..]));
assert_eq!(iter.next(), None);

This method can be used to extract the sorted subslices:

#![feature(slice_group_by)]

let slice = &mut [1, 1, 2, 3, 2, 3, 2, 3, 4];

let mut iter = slice.group_by_mut(|a, b| a <= b);

assert_eq!(iter.next(), Some(&mut [1, 1, 2, 3][..]));
assert_eq!(iter.next(), Some(&mut [2, 3][..]));
assert_eq!(iter.next(), Some(&mut [2, 3, 4][..]));
assert_eq!(iter.next(), None);

pub fn split_at(&self, mid: usize) -> (&[T], &[T])

Divides one slice into two at an index.

The first will contain all indices from [0, mid) (excluding the index mid itself) and the second will contain all indices from [mid, len) (excluding the index len itself).

Panics

Panics if mid > len.

Examples

let v = [1, 2, 3, 4, 5, 6];

{
   let (left, right) = v.split_at(0);
   assert_eq!(left, []);
   assert_eq!(right, [1, 2, 3, 4, 5, 6]);
}

{
    let (left, right) = v.split_at(2);
    assert_eq!(left, [1, 2]);
    assert_eq!(right, [3, 4, 5, 6]);
}

{
    let (left, right) = v.split_at(6);
    assert_eq!(left, [1, 2, 3, 4, 5, 6]);
    assert_eq!(right, []);
}

pub fn split_at_mut(&mut self, mid: usize) -> (&mut [T], &mut [T])

Divides one mutable slice into two at an index.

The first will contain all indices from [0, mid) (excluding the index mid itself) and the second will contain all indices from [mid, len) (excluding the index len itself).

Panics

Panics if mid > len.

Examples

let mut v = [1, 0, 3, 0, 5, 6];
let (left, right) = v.split_at_mut(2);
assert_eq!(left, [1, 0]);
assert_eq!(right, [3, 0, 5, 6]);
left[1] = 2;
right[1] = 4;
assert_eq!(v, [1, 2, 3, 4, 5, 6]);

pub fn split<F>(&self, pred: F) -> Split<'_, T, F> where
    F: FnMut(&T) -> bool, 

Returns an iterator over subslices separated by elements that match pred. The matched element is not contained in the subslices.

Examples

let slice = [10, 40, 33, 20];
let mut iter = slice.split(|num| num % 3 == 0);

assert_eq!(iter.next().unwrap(), &[10, 40]);
assert_eq!(iter.next().unwrap(), &[20]);
assert!(iter.next().is_none());

If the first element is matched, an empty slice will be the first item returned by the iterator. Similarly, if the last element in the slice is matched, an empty slice will be the last item returned by the iterator:

let slice = [10, 40, 33];
let mut iter = slice.split(|num| num % 3 == 0);

assert_eq!(iter.next().unwrap(), &[10, 40]);
assert_eq!(iter.next().unwrap(), &[]);
assert!(iter.next().is_none());

If two matched elements are directly adjacent, an empty slice will be present between them:

let slice = [10, 6, 33, 20];
let mut iter = slice.split(|num| num % 3 == 0);

assert_eq!(iter.next().unwrap(), &[10]);
assert_eq!(iter.next().unwrap(), &[]);
assert_eq!(iter.next().unwrap(), &[20]);
assert!(iter.next().is_none());

pub fn split_mut<F>(&mut self, pred: F) -> SplitMut<'_, T, F> where
    F: FnMut(&T) -> bool, 

Returns an iterator over mutable subslices separated by elements that match pred. The matched element is not contained in the subslices.

Examples

let mut v = [10, 40, 30, 20, 60, 50];

for group in v.split_mut(|num| *num % 3 == 0) {
    group[0] = 1;
}
assert_eq!(v, [1, 40, 30, 1, 60, 1]);

pub fn split_inclusive<F>(&self, pred: F) -> SplitInclusive<'_, T, F> where
    F: FnMut(&T) -> bool, 

Returns an iterator over subslices separated by elements that match pred. The matched element is contained in the end of the previous subslice as a terminator.

Examples

let slice = [10, 40, 33, 20];
let mut iter = slice.split_inclusive(|num| num % 3 == 0);

assert_eq!(iter.next().unwrap(), &[10, 40, 33]);
assert_eq!(iter.next().unwrap(), &[20]);
assert!(iter.next().is_none());

If the last element of the slice is matched, that element will be considered the terminator of the preceding slice. That slice will be the last item returned by the iterator.

let slice = [3, 10, 40, 33];
let mut iter = slice.split_inclusive(|num| num % 3 == 0);

assert_eq!(iter.next().unwrap(), &[3]);
assert_eq!(iter.next().unwrap(), &[10, 40, 33]);
assert!(iter.next().is_none());

pub fn split_inclusive_mut<F>(&mut self, pred: F) -> SplitInclusiveMut<'_, T, F> where
    F: FnMut(&T) -> bool, 

Returns an iterator over mutable subslices separated by elements that match pred. The matched element is contained in the previous subslice as a terminator.

Examples

let mut v = [10, 40, 30, 20, 60, 50];

for group in v.split_inclusive_mut(|num| *num % 3 == 0) {
    let terminator_idx = group.len()-1;
    group[terminator_idx] = 1;
}
assert_eq!(v, [10, 40, 1, 20, 1, 1]);

pub fn rsplit<F>(&self, pred: F) -> RSplit<'_, T, F> where
    F: FnMut(&T) -> bool, 

Returns an iterator over subslices separated by elements that match pred, starting at the end of the slice and working backwards. The matched element is not contained in the subslices.

Examples

let slice = [11, 22, 33, 0, 44, 55];
let mut iter = slice.rsplit(|num| *num == 0);

assert_eq!(iter.next().unwrap(), &[44, 55]);
assert_eq!(iter.next().unwrap(), &[11, 22, 33]);
assert_eq!(iter.next(), None);

As with split(), if the first or last element is matched, an empty slice will be the first (or last) item returned by the iterator.

let v = &[0, 1, 1, 2, 3, 5, 8];
let mut it = v.rsplit(|n| *n % 2 == 0);
assert_eq!(it.next().unwrap(), &[]);
assert_eq!(it.next().unwrap(), &[3, 5]);
assert_eq!(it.next().unwrap(), &[1, 1]);
assert_eq!(it.next().unwrap(), &[]);
assert_eq!(it.next(), None);

pub fn rsplit_mut<F>(&mut self, pred: F) -> RSplitMut<'_, T, F> where
    F: FnMut(&T) -> bool, 

Returns an iterator over mutable subslices separated by elements that match pred, starting at the end of the slice and working backwards. The matched element is not contained in the subslices.

Examples

let mut v = [100, 400, 300, 200, 600, 500];

let mut count = 0;
for group in v.rsplit_mut(|num| *num % 3 == 0) {
    count += 1;
    group[0] = count;
}
assert_eq!(v, [3, 400, 300, 2, 600, 1]);

pub fn splitn<F>(&self, n: usize, pred: F) -> SplitN<'_, T, F> where
    F: FnMut(&T) -> bool, 

Returns an iterator over subslices separated by elements that match pred, limited to returning at most n items. The matched element is not contained in the subslices.

The last element returned, if any, will contain the remainder of the slice.

Examples

Print the slice split once by numbers divisible by 3 (i.e., [10, 40], [20, 60, 50]):

let v = [10, 40, 30, 20, 60, 50];

for group in v.splitn(2, |num| *num % 3 == 0) {
    println!("{:?}", group);
}

pub fn splitn_mut<F>(&mut self, n: usize, pred: F) -> SplitNMut<'_, T, F> where
    F: FnMut(&T) -> bool, 

Returns an iterator over subslices separated by elements that match pred, limited to returning at most n items. The matched element is not contained in the subslices.

The last element returned, if any, will contain the remainder of the slice.

Examples

let mut v = [10, 40, 30, 20, 60, 50];

for group in v.splitn_mut(2, |num| *num % 3 == 0) {
    group[0] = 1;
}
assert_eq!(v, [1, 40, 30, 1, 60, 50]);

pub fn rsplitn<F>(&self, n: usize, pred: F) -> RSplitN<'_, T, F> where
    F: FnMut(&T) -> bool, 

Returns an iterator over subslices separated by elements that match pred limited to returning at most n items. This starts at the end of the slice and works backwards. The matched element is not contained in the subslices.

The last element returned, if any, will contain the remainder of the slice.

Examples

Print the slice split once, starting from the end, by numbers divisible by 3 (i.e., [50], [10, 40, 30, 20]):

let v = [10, 40, 30, 20, 60, 50];

for group in v.rsplitn(2, |num| *num % 3 == 0) {
    println!("{:?}", group);
}

pub fn rsplitn_mut<F>(&mut self, n: usize, pred: F) -> RSplitNMut<'_, T, F> where
    F: FnMut(&T) -> bool, 

Returns an iterator over subslices separated by elements that match pred limited to returning at most n items. This starts at the end of the slice and works backwards. The matched element is not contained in the subslices.

The last element returned, if any, will contain the remainder of the slice.

Examples

let mut s = [10, 40, 30, 20, 60, 50];

for group in s.rsplitn_mut(2, |num| *num % 3 == 0) {
    group[0] = 1;
}
assert_eq!(s, [1, 40, 30, 20, 60, 1]);

pub fn contains(&self, x: &T) -> bool where
    T: PartialEq<T>, 

Returns true if the slice contains an element with the given value.

Examples

let v = [10, 40, 30];
assert!(v.contains(&30));
assert!(!v.contains(&50));

If you do not have an &T, but just an &U such that T: Borrow<U> (e.g. String: Borrow<str>), you can use iter().any:

let v = [String::from("hello"), String::from("world")]; // slice of `String`
assert!(v.iter().any(|e| e == "hello")); // search with `&str`
assert!(!v.iter().any(|e| e == "hi"));

pub fn starts_with(&self, needle: &[T]) -> bool where
    T: PartialEq<T>, 

Returns true if needle is a prefix of the slice.

Examples

let v = [10, 40, 30];
assert!(v.starts_with(&[10]));
assert!(v.starts_with(&[10, 40]));
assert!(!v.starts_with(&[50]));
assert!(!v.starts_with(&[10, 50]));

Always returns true if needle is an empty slice:

let v = &[10, 40, 30];
assert!(v.starts_with(&[]));
let v: &[u8] = &[];
assert!(v.starts_with(&[]));

pub fn ends_with(&self, needle: &[T]) -> bool where
    T: PartialEq<T>, 

Returns true if needle is a suffix of the slice.

Examples

let v = [10, 40, 30];
assert!(v.ends_with(&[30]));
assert!(v.ends_with(&[40, 30]));
assert!(!v.ends_with(&[50]));
assert!(!v.ends_with(&[50, 30]));

Always returns true if needle is an empty slice:

let v = &[10, 40, 30];
assert!(v.ends_with(&[]));
let v: &[u8] = &[];
assert!(v.ends_with(&[]));

#[must_use = "returns the subslice without modifying the original"]pub fn strip_prefix<P>(&self, prefix: &P) -> Option<&[T]> where
    T: PartialEq<T>,
    P: SlicePattern<Item = T> + ?Sized, 

Returns a subslice with the prefix removed.

If the slice starts with prefix, returns the subslice after the prefix, wrapped in Some. If prefix is empty, simply returns the original slice.

If the slice does not start with prefix, returns None.

Examples

let v = &[10, 40, 30];
assert_eq!(v.strip_prefix(&[10]), Some(&[40, 30][..]));
assert_eq!(v.strip_prefix(&[10, 40]), Some(&[30][..]));
assert_eq!(v.strip_prefix(&[50]), None);
assert_eq!(v.strip_prefix(&[10, 50]), None);

let prefix : &str = "he";
assert_eq!(b"hello".strip_prefix(prefix.as_bytes()),
           Some(b"llo".as_ref()));

#[must_use = "returns the subslice without modifying the original"]pub fn strip_suffix<P>(&self, suffix: &P) -> Option<&[T]> where
    T: PartialEq<T>,
    P: SlicePattern<Item = T> + ?Sized, 

Returns a subslice with the suffix removed.

If the slice ends with suffix, returns the subslice before the suffix, wrapped in Some. If suffix is empty, simply returns the original slice.

If the slice does not end with suffix, returns None.

Examples

let v = &[10, 40, 30];
assert_eq!(v.strip_suffix(&[30]), Some(&[10, 40][..]));
assert_eq!(v.strip_suffix(&[40, 30]), Some(&[10][..]));
assert_eq!(v.strip_suffix(&[50]), None);
assert_eq!(v.strip_suffix(&[50, 30]), None);

pub fn binary_search(&self, x: &T) -> Result<usize, usize> where
    T: Ord, 

Binary searches this sorted slice for a given element.

If the value is found then Result::Ok is returned, containing the index of the matching element. If there are multiple matches, then any one of the matches could be returned. If the value is not found then Result::Err is returned, containing the index where a matching element could be inserted while maintaining sorted order.

See also binary_search_by, binary_search_by_key, and partition_point.

Examples

Looks up a series of four elements. The first is found, with a uniquely determined position; the second and third are not found; the fourth could match any position in [1, 4].

let s = [0, 1, 1, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55];

assert_eq!(s.binary_search(&13),  Ok(9));
assert_eq!(s.binary_search(&4),   Err(7));
assert_eq!(s.binary_search(&100), Err(13));
let r = s.binary_search(&1);
assert!(match r { Ok(1..=4) => true, _ => false, });

If you want to insert an item to a sorted vector, while maintaining sort order:

let mut s = vec![0, 1, 1, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55];
let num = 42;
let idx = s.binary_search(&num).unwrap_or_else(|x| x);
s.insert(idx, num);
assert_eq!(s, [0, 1, 1, 1, 1, 2, 3, 5, 8, 13, 21, 34, 42, 55]);

pub fn binary_search_by<'a, F>(&'a self, f: F) -> Result<usize, usize> where
    F: FnMut(&'a T) -> Ordering, 

Binary searches this sorted slice with a comparator function.

The comparator function should implement an order consistent with the sort order of the underlying slice, returning an order code that indicates whether its argument is Less, Equal or Greater the desired target.

If the value is found then Result::Ok is returned, containing the index of the matching element. If there are multiple matches, then any one of the matches could be returned. If the value is not found then Result::Err is returned, containing the index where a matching element could be inserted while maintaining sorted order.

See also binary_search, binary_search_by_key, and partition_point.

Examples

Looks up a series of four elements. The first is found, with a uniquely determined position; the second and third are not found; the fourth could match any position in [1, 4].

let s = [0, 1, 1, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55];

let seek = 13;
assert_eq!(s.binary_search_by(|probe| probe.cmp(&seek)), Ok(9));
let seek = 4;
assert_eq!(s.binary_search_by(|probe| probe.cmp(&seek)), Err(7));
let seek = 100;
assert_eq!(s.binary_search_by(|probe| probe.cmp(&seek)), Err(13));
let seek = 1;
let r = s.binary_search_by(|probe| probe.cmp(&seek));
assert!(match r { Ok(1..=4) => true, _ => false, });

pub fn binary_search_by_key<'a, B, F>(
    &'a self,
    b: &B,
    f: F
) -> Result<usize, usize> where
    F: FnMut(&'a T) -> B,
    B: Ord, 

Binary searches this sorted slice with a key extraction function.

Assumes that the slice is sorted by the key, for instance with sort_by_key using the same key extraction function.

If the value is found then Result::Ok is returned, containing the index of the matching element. If there are multiple matches, then any one of the matches could be returned. If the value is not found then Result::Err is returned, containing the index where a matching element could be inserted while maintaining sorted order.

See also binary_search, binary_search_by, and partition_point.

Examples

Looks up a series of four elements in a slice of pairs sorted by their second elements. The first is found, with a uniquely determined position; the second and third are not found; the fourth could match any position in [1, 4].

let s = [(0, 0), (2, 1), (4, 1), (5, 1), (3, 1),
         (1, 2), (2, 3), (4, 5), (5, 8), (3, 13),
         (1, 21), (2, 34), (4, 55)];

assert_eq!(s.binary_search_by_key(&13, |&(a, b)| b),  Ok(9));
assert_eq!(s.binary_search_by_key(&4, |&(a, b)| b),   Err(7));
assert_eq!(s.binary_search_by_key(&100, |&(a, b)| b), Err(13));
let r = s.binary_search_by_key(&1, |&(a, b)| b);
assert!(match r { Ok(1..=4) => true, _ => false, });

pub fn sort_unstable(&mut self) where
    T: Ord, 

Sorts the slice, but may not preserve the order of equal elements.

This sort is unstable (i.e., may reorder equal elements), in-place (i.e., does not allocate), and O(n * log(n)) worst-case.

Current implementation

The current algorithm is based on pattern-defeating quicksort by Orson Peters, which combines the fast average case of randomized quicksort with the fast worst case of heapsort, while achieving linear time on slices with certain patterns. It uses some randomization to avoid degenerate cases, but with a fixed seed to always provide deterministic behavior.

It is typically faster than stable sorting, except in a few special cases, e.g., when the slice consists of several concatenated sorted sequences.

Examples

let mut v = [-5, 4, 1, -3, 2];

v.sort_unstable();
assert!(v == [-5, -3, 1, 2, 4]);

pub fn sort_unstable_by<F>(&mut self, compare: F) where
    F: FnMut(&T, &T) -> Ordering, 

Sorts the slice with a comparator function, but may not preserve the order of equal elements.

This sort is unstable (i.e., may reorder equal elements), in-place (i.e., does not allocate), and O(n * log(n)) worst-case.

The comparator function must define a total ordering for the elements in the slice. If the ordering is not total, the order of the elements is unspecified. An order is a total order if it is (for all a, b and c):

• total and antisymmetric: exactly one of a < b, a == b or a > b is true, and
• transitive, a < b and b < c implies a < c. The same must hold for both == and >.

For example, while f64 doesn’t implement Ord because NaN != NaN, we can use partial_cmp as our sort function when we know the slice doesn’t contain a NaN.

let mut floats = [5f64, 4.0, 1.0, 3.0, 2.0];
floats.sort_unstable_by(|a, b| a.partial_cmp(b).unwrap());
assert_eq!(floats, [1.0, 2.0, 3.0, 4.0, 5.0]);

Current implementation

The current algorithm is based on pattern-defeating quicksort by Orson Peters, which combines the fast average case of randomized quicksort with the fast worst case of heapsort, while achieving linear time on slices with certain patterns. It uses some randomization to avoid degenerate cases, but with a fixed seed to always provide deterministic behavior.

It is typically faster than stable sorting, except in a few special cases, e.g., when the slice consists of several concatenated sorted sequences.

Examples

let mut v = [5, 4, 1, 3, 2];
v.sort_unstable_by(|a, b| a.cmp(b));
assert!(v == [1, 2, 3, 4, 5]);

// reverse sorting
v.sort_unstable_by(|a, b| b.cmp(a));
assert!(v == [5, 4, 3, 2, 1]);

pub fn sort_unstable_by_key<K, F>(&mut self, f: F) where
    F: FnMut(&T) -> K,
    K: Ord, 

Sorts the slice with a key extraction function, but may not preserve the order of equal elements.

This sort is unstable (i.e., may reorder equal elements), in-place (i.e., does not allocate), and O(m * n * log(n)) worst-case, where the key function is O(m).

Current implementation

The current algorithm is based on pattern-defeating quicksort by Orson Peters, which combines the fast average case of randomized quicksort with the fast worst case of heapsort, while achieving linear time on slices with certain patterns. It uses some randomization to avoid degenerate cases, but with a fixed seed to always provide deterministic behavior.

Due to its key calling strategy, sort_unstable_by_key is likely to be slower than sort_by_cached_key in cases where the key function is expensive.

Examples

let mut v = [-5i32, 4, 1, -3, 2];

v.sort_unstable_by_key(|k| k.abs());
assert!(v == [1, 2, -3, 4, -5]);

pub fn partition_at_index(
    &mut self,
    index: usize
) -> (&mut [T], &mut T, &mut [T]) where
    T: Ord, 

👎 Deprecated since 1.49.0:

use the select_nth_unstable() instead

🔬 This is a nightly-only experimental API. (slice_partition_at_index)

Reorder the slice such that the element at index is at its final sorted position.

pub fn partition_at_index_by<F>(
    &mut self,
    index: usize,
    compare: F
) -> (&mut [T], &mut T, &mut [T]) where
    F: FnMut(&T, &T) -> Ordering, 

👎 Deprecated since 1.49.0:

use select_nth_unstable_by() instead

🔬 This is a nightly-only experimental API. (slice_partition_at_index)

Reorder the slice with a comparator function such that the element at index is at its final sorted position.

pub fn partition_at_index_by_key<K, F>(
    &mut self,
    index: usize,
    f: F
) -> (&mut [T], &mut T, &mut [T]) where
    F: FnMut(&T) -> K,
    K: Ord, 

👎 Deprecated since 1.49.0:

use the select_nth_unstable_by_key() instead

🔬 This is a nightly-only experimental API. (slice_partition_at_index)

Reorder the slice with a key extraction function such that the element at index is at its final sorted position.

pub fn select_nth_unstable(
    &mut self,
    index: usize
) -> (&mut [T], &mut T, &mut [T]) where
    T: Ord, 

Reorder the slice such that the element at index is at its final sorted position.

This reordering has the additional property that any value at position i < index will be less than or equal to any value at a position j > index. Additionally, this reordering is unstable (i.e. any number of equal elements may end up at position index), in-place (i.e. does not allocate), and O(n) worst-case. This function is also/ known as “kth element” in other libraries. It returns a triplet of the following values: all elements less than the one at the given index, the value at the given index, and all elements greater than the one at the given index.

Current implementation

The current algorithm is based on the quickselect portion of the same quicksort algorithm used for sort_unstable.

Panics

Panics when index >= len(), meaning it always panics on empty slices.

Examples

let mut v = [-5i32, 4, 1, -3, 2];

// Find the median
v.select_nth_unstable(2);

// We are only guaranteed the slice will be one of the following, based on the way we sort
// about the specified index.
assert!(v == [-3, -5, 1, 2, 4] ||
        v == [-5, -3, 1, 2, 4] ||
        v == [-3, -5, 1, 4, 2] ||
        v == [-5, -3, 1, 4, 2]);

pub fn select_nth_unstable_by<F>(
    &mut self,
    index: usize,
    compare: F
) -> (&mut [T], &mut T, &mut [T]) where
    F: FnMut(&T, &T) -> Ordering, 

Reorder the slice with a comparator function such that the element at index is at its final sorted position.

This reordering has the additional property that any value at position i < index will be less than or equal to any value at a position j > index using the comparator function. Additionally, this reordering is unstable (i.e. any number of equal elements may end up at position index), in-place (i.e. does not allocate), and O(n) worst-case. This function is also known as “kth element” in other libraries. It returns a triplet of the following values: all elements less than the one at the given index, the value at the given index, and all elements greater than the one at the given index, using the provided comparator function.

Current implementation

The current algorithm is based on the quickselect portion of the same quicksort algorithm used for sort_unstable.

Panics

Panics when index >= len(), meaning it always panics on empty slices.

Examples

let mut v = [-5i32, 4, 1, -3, 2];

// Find the median as if the slice were sorted in descending order.
v.select_nth_unstable_by(2, |a, b| b.cmp(a));

// We are only guaranteed the slice will be one of the following, based on the way we sort
// about the specified index.
assert!(v == [2, 4, 1, -5, -3] ||
        v == [2, 4, 1, -3, -5] ||
        v == [4, 2, 1, -5, -3] ||
        v == [4, 2, 1, -3, -5]);

pub fn select_nth_unstable_by_key<K, F>(
    &mut self,
    index: usize,
    f: F
) -> (&mut [T], &mut T, &mut [T]) where
    F: FnMut(&T) -> K,
    K: Ord, 

Reorder the slice with a key extraction function such that the element at index is at its final sorted position.

This reordering has the additional property that any value at position i < index will be less than or equal to any value at a position j > index using the key extraction function. Additionally, this reordering is unstable (i.e. any number of equal elements may end up at position index), in-place (i.e. does not allocate), and O(n) worst-case. This function is also known as “kth element” in other libraries. It returns a triplet of the following values: all elements less than the one at the given index, the value at the given index, and all elements greater than the one at the given index, using the provided key extraction function.

Current implementation

The current algorithm is based on the quickselect portion of the same quicksort algorithm used for sort_unstable.

Panics

Panics when index >= len(), meaning it always panics on empty slices.

Examples

let mut v = [-5i32, 4, 1, -3, 2];

// Return the median as if the array were sorted according to absolute value.
v.select_nth_unstable_by_key(2, |a| a.abs());

// We are only guaranteed the slice will be one of the following, based on the way we sort
// about the specified index.
assert!(v == [1, 2, -3, 4, -5] ||
        v == [1, 2, -3, -5, 4] ||
        v == [2, 1, -3, 4, -5] ||
        v == [2, 1, -3, -5, 4]);

pub fn partition_dedup(&mut self) -> (&mut [T], &mut [T]) where
    T: PartialEq<T>, 

🔬 This is a nightly-only experimental API. (slice_partition_dedup)

Moves all consecutive repeated elements to the end of the slice according to the PartialEq trait implementation.

Returns two slices. The first contains no consecutive repeated elements. The second contains all the duplicates in no specified order.

If the slice is sorted, the first returned slice contains no duplicates.

Examples

#![feature(slice_partition_dedup)]

let mut slice = [1, 2, 2, 3, 3, 2, 1, 1];

let (dedup, duplicates) = slice.partition_dedup();

assert_eq!(dedup, [1, 2, 3, 2, 1]);
assert_eq!(duplicates, [2, 3, 1]);

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

🔬 This is a nightly-only experimental API. (slice_partition_dedup)

Moves all but the first of consecutive elements to the end of the slice satisfying a given equality relation.

Returns two slices. The first contains no consecutive repeated elements. The second contains all the duplicates in no specified order.

The same_bucket function is passed references to two elements from the slice and must determine if the elements compare equal. The elements are passed in opposite order from their order in the slice, so if same_bucket(a, b) returns true, a is moved at the end of the slice.

If the slice is sorted, the first returned slice contains no duplicates.

Examples

#![feature(slice_partition_dedup)]

let mut slice = ["foo", "Foo", "BAZ", "Bar", "bar", "baz", "BAZ"];

let (dedup, duplicates) = slice.partition_dedup_by(|a, b| a.eq_ignore_ascii_case(b));

assert_eq!(dedup, ["foo", "BAZ", "Bar", "baz"]);
assert_eq!(duplicates, ["bar", "Foo", "BAZ"]);

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

🔬 This is a nightly-only experimental API. (slice_partition_dedup)

Moves all but the first of consecutive elements to the end of the slice that resolve to the same key.

Returns two slices. The first contains no consecutive repeated elements. The second contains all the duplicates in no specified order.

If the slice is sorted, the first returned slice contains no duplicates.

Examples

#![feature(slice_partition_dedup)]

let mut slice = [10, 20, 21, 30, 30, 20, 11, 13];

let (dedup, duplicates) = slice.partition_dedup_by_key(|i| *i / 10);

assert_eq!(dedup, [10, 20, 30, 20, 11]);
assert_eq!(duplicates, [21, 30, 13]);

pub fn rotate_left(&mut self, mid: usize)

Rotates the slice in-place such that the first mid elements of the slice move to the end while the last self.len() - mid elements move to the front. After calling rotate_left, the element previously at index mid will become the first element in the slice.

Panics

This function will panic if mid is greater than the length of the slice. Note that mid == self.len() does not panic and is a no-op rotation.

Complexity

Takes linear (in self.len()) time.

Examples

let mut a = ['a', 'b', 'c', 'd', 'e', 'f'];
a.rotate_left(2);
assert_eq!(a, ['c', 'd', 'e', 'f', 'a', 'b']);

Rotating a subslice:

let mut a = ['a', 'b', 'c', 'd', 'e', 'f'];
a[1..5].rotate_left(1);
assert_eq!(a, ['a', 'c', 'd', 'e', 'b', 'f']);

pub fn rotate_right(&mut self, k: usize)

Rotates the slice in-place such that the first self.len() - k elements of the slice move to the end while the last k elements move to the front. After calling rotate_right, the element previously at index self.len() - k will become the first element in the slice.

Panics

This function will panic if k is greater than the length of the slice. Note that k == self.len() does not panic and is a no-op rotation.

Complexity

Takes linear (in self.len()) time.

Examples

let mut a = ['a', 'b', 'c', 'd', 'e', 'f'];
a.rotate_right(2);
assert_eq!(a, ['e', 'f', 'a', 'b', 'c', 'd']);

Rotate a subslice:

let mut a = ['a', 'b', 'c', 'd', 'e', 'f'];
a[1..5].rotate_right(1);
assert_eq!(a, ['a', 'e', 'b', 'c', 'd', 'f']);

pub fn fill(&mut self, value: T) where
    T: Clone, 

Fills self with elements by cloning value.

Examples

let mut buf = vec![0; 10];
buf.fill(1);
assert_eq!(buf, vec![1; 10]);

pub fn fill_with<F>(&mut self, f: F) where
    F: FnMut() -> T, 

Fills self with elements returned by calling a closure repeatedly.

This method uses a closure to create new values. If you’d rather Clone a given value, use fill. If you want to use the Default trait to generate values, you can pass Default::default as the argument.

Examples

let mut buf = vec![1; 10];
buf.fill_with(Default::default);
assert_eq!(buf, vec![0; 10]);

pub fn clone_from_slice(&mut self, src: &[T]) where
    T: Clone, 

Copies the elements from src into self.

The length of src must be the same as self.

If T implements Copy, it can be more performant to use copy_from_slice.

Panics

This function will panic if the two slices have different lengths.

Examples

Cloning two elements from a slice into another:

let src = [1, 2, 3, 4];
let mut dst = [0, 0];

// Because the slices have to be the same length,
// we slice the source slice from four elements
// to two. It will panic if we don't do this.
dst.clone_from_slice(&src[2..]);

assert_eq!(src, [1, 2, 3, 4]);
assert_eq!(dst, [3, 4]);

Rust enforces that there can only be one mutable reference with no immutable references to a particular piece of data in a particular scope. Because of this, attempting to use clone_from_slice on a single slice will result in a compile failure:

let mut slice = [1, 2, 3, 4, 5];

slice[..2].clone_from_slice(&slice[3..]); // compile fail!

To work around this, we can use split_at_mut to create two distinct sub-slices from a slice:

let mut slice = [1, 2, 3, 4, 5];

{
    let (left, right) = slice.split_at_mut(2);
    left.clone_from_slice(&right[1..]);
}

assert_eq!(slice, [4, 5, 3, 4, 5]);

pub fn copy_from_slice(&mut self, src: &[T]) where
    T: Copy, 

Copies all elements from src into self, using a memcpy.

The length of src must be the same as self.

If T does not implement Copy, use clone_from_slice.

Panics

This function will panic if the two slices have different lengths.

Examples

Copying two elements from a slice into another:

let src = [1, 2, 3, 4];
let mut dst = [0, 0];

// Because the slices have to be the same length,
// we slice the source slice from four elements
// to two. It will panic if we don't do this.
dst.copy_from_slice(&src[2..]);

assert_eq!(src, [1, 2, 3, 4]);
assert_eq!(dst, [3, 4]);

Rust enforces that there can only be one mutable reference with no immutable references to a particular piece of data in a particular scope. Because of this, attempting to use copy_from_slice on a single slice will result in a compile failure:

let mut slice = [1, 2, 3, 4, 5];

slice[..2].copy_from_slice(&slice[3..]); // compile fail!

To work around this, we can use split_at_mut to create two distinct sub-slices from a slice:

let mut slice = [1, 2, 3, 4, 5];

{
    let (left, right) = slice.split_at_mut(2);
    left.copy_from_slice(&right[1..]);
}

assert_eq!(slice, [4, 5, 3, 4, 5]);

pub fn copy_within<R>(&mut self, src: R, dest: usize) where
    T: Copy,
    R: RangeBounds<usize>, 

Copies elements from one part of the slice to another part of itself, using a memmove.

src is the range within self to copy from. dest is the starting index of the range within self to copy to, which will have the same length as src. The two ranges may overlap. The ends of the two ranges must be less than or equal to self.len().

Panics

This function will panic if either range exceeds the end of the slice, or if the end of src is before the start.

Examples

Copying four bytes within a slice:

let mut bytes = *b"Hello, World!";

bytes.copy_within(1..5, 8);

assert_eq!(&bytes, b"Hello, Wello!");

pub fn swap_with_slice(&mut self, other: &mut [T])

Swaps all elements in self with those in other.

The length of other must be the same as self.

Panics

This function will panic if the two slices have different lengths.

Example

Swapping two elements across slices:

let mut slice1 = [0, 0];
let mut slice2 = [1, 2, 3, 4];

slice1.swap_with_slice(&mut slice2[2..]);

assert_eq!(slice1, [3, 4]);
assert_eq!(slice2, [1, 2, 0, 0]);

Rust enforces that there can only be one mutable reference to a particular piece of data in a particular scope. Because of this, attempting to use swap_with_slice on a single slice will result in a compile failure:

let mut slice = [1, 2, 3, 4, 5];
slice[..2].swap_with_slice(&mut slice[3..]); // compile fail!

To work around this, we can use split_at_mut to create two distinct mutable sub-slices from a slice:

let mut slice = [1, 2, 3, 4, 5];

{
    let (left, right) = slice.split_at_mut(2);
    left.swap_with_slice(&mut right[1..]);
}

assert_eq!(slice, [4, 5, 3, 1, 2]);

pub unsafe fn align_to<U>(&self) -> (&[T], &[U], &[T])

Transmute the slice to a slice of another type, ensuring alignment of the types is maintained.

This method splits the slice into three distinct slices: prefix, correctly aligned middle slice of a new type, and the suffix slice. The method may make the middle slice the greatest length possible for a given type and input slice, but only your algorithm’s performance should depend on that, not its correctness. It is permissible for all of the input data to be returned as the prefix or suffix slice.

This method has no purpose when either input element T or output element U are zero-sized and will return the original slice without splitting anything.

Safety

This method is essentially a transmute with respect to the elements in the returned middle slice, so all the usual caveats pertaining to transmute::<T, U> also apply here.

Examples

Basic usage:

unsafe {
    let bytes: [u8; 7] = [1, 2, 3, 4, 5, 6, 7];
    let (prefix, shorts, suffix) = bytes.align_to::<u16>();
    // less_efficient_algorithm_for_bytes(prefix);
    // more_efficient_algorithm_for_aligned_shorts(shorts);
    // less_efficient_algorithm_for_bytes(suffix);
}

pub unsafe fn align_to_mut<U>(&mut self) -> (&mut [T], &mut [U], &mut [T])

Transmute the slice to a slice of another type, ensuring alignment of the types is maintained.

This method splits the slice into three distinct slices: prefix, correctly aligned middle slice of a new type, and the suffix slice. The method may make the middle slice the greatest length possible for a given type and input slice, but only your algorithm’s performance should depend on that, not its correctness. It is permissible for all of the input data to be returned as the prefix or suffix slice.

This method has no purpose when either input element T or output element U are zero-sized and will return the original slice without splitting anything.

Safety

This method is essentially a transmute with respect to the elements in the returned middle slice, so all the usual caveats pertaining to transmute::<T, U> also apply here.

Examples

Basic usage:

unsafe {
    let mut bytes: [u8; 7] = [1, 2, 3, 4, 5, 6, 7];
    let (prefix, shorts, suffix) = bytes.align_to_mut::<u16>();
    // less_efficient_algorithm_for_bytes(prefix);
    // more_efficient_algorithm_for_aligned_shorts(shorts);
    // less_efficient_algorithm_for_bytes(suffix);
}

pub fn is_sorted(&self) -> bool where
    T: PartialOrd<T>, 

🔬 This is a nightly-only experimental API. (is_sorted)

new API

Checks if the elements of this slice are sorted.

That is, for each element a and its following element b, a <= b must hold. If the slice yields exactly zero or one element, true is returned.

Note that if Self::Item is only PartialOrd, but not Ord, the above definition implies that this function returns false if any two consecutive items are not comparable.

Examples

#![feature(is_sorted)]
let empty: [i32; 0] = [];

assert!([1, 2, 2, 9].is_sorted());
assert!(![1, 3, 2, 4].is_sorted());
assert!([0].is_sorted());
assert!(empty.is_sorted());
assert!(![0.0, 1.0, f32::NAN].is_sorted());

pub fn is_sorted_by<F>(&self, compare: F) -> bool where
    F: FnMut(&T, &T) -> Option<Ordering>, 

🔬 This is a nightly-only experimental API. (is_sorted)

new API

Checks if the elements of this slice are sorted using the given comparator function.

Instead of using PartialOrd::partial_cmp, this function uses the given compare function to determine the ordering of two elements. Apart from that, it’s equivalent to is_sorted; see its documentation for more information.

pub fn is_sorted_by_key<F, K>(&self, f: F) -> bool where
    F: FnMut(&T) -> K,
    K: PartialOrd<K>, 

🔬 This is a nightly-only experimental API. (is_sorted)

new API

Checks if the elements of this slice are sorted using the given key extraction function.

Instead of comparing the slice’s elements directly, this function compares the keys of the elements, as determined by f. Apart from that, it’s equivalent to is_sorted; see its documentation for more information.

Examples

#![feature(is_sorted)]

assert!(["c", "bb", "aaa"].is_sorted_by_key(|s| s.len()));
assert!(![-2i32, -1, 0, 3].is_sorted_by_key(|n| n.abs()));

pub fn partition_point<P>(&self, pred: P) -> usize where
    P: FnMut(&T) -> bool, 

Returns the index of the partition point according to the given predicate (the index of the first element of the second partition).

The slice is assumed to be partitioned according to the given predicate. This means that all elements for which the predicate returns true are at the start of the slice and all elements for which the predicate returns false are at the end. For example, [7, 15, 3, 5, 4, 12, 6] is a partitioned under the predicate x % 2 != 0 (all odd numbers are at the start, all even at the end).

If this slice is not partitioned, the returned result is unspecified and meaningless, as this method performs a kind of binary search.

See also binary_search, binary_search_by, and binary_search_by_key.

Examples

let v = [1, 2, 3, 3, 5, 6, 7];
let i = v.partition_point(|&x| x < 5);

assert_eq!(i, 4);
assert!(v[..i].iter().all(|&x| x < 5));
assert!(v[i..].iter().all(|&x| !(x < 5)));

pub fn is_ascii(&self) -> bool

Checks if all bytes in this slice are within the ASCII range.

pub fn eq_ignore_ascii_case(&self, other: &[u8]) -> bool

Checks that two slices are an ASCII case-insensitive match.

Same as to_ascii_lowercase(a) == to_ascii_lowercase(b), but without allocating and copying temporaries.

pub fn make_ascii_uppercase(&mut self)

Converts this slice to its ASCII upper case equivalent in-place.

ASCII letters ‘a’ to ‘z’ are mapped to ‘A’ to ‘Z’, but non-ASCII letters are unchanged.

To return a new uppercased value without modifying the existing one, use to_ascii_uppercase.

pub fn make_ascii_lowercase(&mut self)

Converts this slice to its ASCII lower case equivalent in-place.

ASCII letters ‘A’ to ‘Z’ are mapped to ‘a’ to ‘z’, but non-ASCII letters are unchanged.

To return a new lowercased value without modifying the existing one, use to_ascii_lowercase.

pub fn sort(&mut self) where
    T: Ord, 

Sorts the slice.

This sort is stable (i.e., does not reorder equal elements) and O(n * log(n)) worst-case.

When applicable, unstable sorting is preferred because it is generally faster than stable sorting and it doesn’t allocate auxiliary memory. See sort_unstable.

Current implementation

The current algorithm is an adaptive, iterative merge sort inspired by timsort. It is designed to be very fast in cases where the slice is nearly sorted, or consists of two or more sorted sequences concatenated one after another.

Also, it allocates temporary storage half the size of self, but for short slices a non-allocating insertion sort is used instead.

Examples

let mut v = [-5, 4, 1, -3, 2];

v.sort();
assert!(v == [-5, -3, 1, 2, 4]);

pub fn sort_by<F>(&mut self, compare: F) where
    F: FnMut(&T, &T) -> Ordering, 

Sorts the slice with a comparator function.

This sort is stable (i.e., does not reorder equal elements) and O(n * log(n)) worst-case.

The comparator function must define a total ordering for the elements in the slice. If the ordering is not total, the order of the elements is unspecified. An order is a total order if it is (for all a, b and c):

• total and antisymmetric: exactly one of a < b, a == b or a > b is true, and
• transitive, a < b and b < c implies a < c. The same must hold for both == and >.

For example, while f64 doesn’t implement Ord because NaN != NaN, we can use partial_cmp as our sort function when we know the slice doesn’t contain a NaN.

let mut floats = [5f64, 4.0, 1.0, 3.0, 2.0];
floats.sort_by(|a, b| a.partial_cmp(b).unwrap());
assert_eq!(floats, [1.0, 2.0, 3.0, 4.0, 5.0]);

When applicable, unstable sorting is preferred because it is generally faster than stable sorting and it doesn’t allocate auxiliary memory. See sort_unstable_by.

Current implementation

The current algorithm is an adaptive, iterative merge sort inspired by timsort. It is designed to be very fast in cases where the slice is nearly sorted, or consists of two or more sorted sequences concatenated one after another.

Also, it allocates temporary storage half the size of self, but for short slices a non-allocating insertion sort is used instead.

Examples

let mut v = [5, 4, 1, 3, 2];
v.sort_by(|a, b| a.cmp(b));
assert!(v == [1, 2, 3, 4, 5]);

// reverse sorting
v.sort_by(|a, b| b.cmp(a));
assert!(v == [5, 4, 3, 2, 1]);

pub fn sort_by_key<K, F>(&mut self, f: F) where
    F: FnMut(&T) -> K,
    K: Ord, 

Sorts the slice with a key extraction function.

This sort is stable (i.e., does not reorder equal elements) and O(m * n * log(n)) worst-case, where the key function is O(m).

For expensive key functions (e.g. functions that are not simple property accesses or basic operations), sort_by_cached_key is likely to be significantly faster, as it does not recompute element keys.

When applicable, unstable sorting is preferred because it is generally faster than stable sorting and it doesn’t allocate auxiliary memory. See sort_unstable_by_key.

Current implementation

The current algorithm is an adaptive, iterative merge sort inspired by timsort. It is designed to be very fast in cases where the slice is nearly sorted, or consists of two or more sorted sequences concatenated one after another.

Also, it allocates temporary storage half the size of self, but for short slices a non-allocating insertion sort is used instead.

Examples

let mut v = [-5i32, 4, 1, -3, 2];

v.sort_by_key(|k| k.abs());
assert!(v == [1, 2, -3, 4, -5]);

pub fn sort_by_cached_key<K, F>(&mut self, f: F) where
    F: FnMut(&T) -> K,
    K: Ord, 

Sorts the slice with a key extraction function.

During sorting, the key function is called only once per element.

This sort is stable (i.e., does not reorder equal elements) and O(m * n + n * log(n)) worst-case, where the key function is O(m).

For simple key functions (e.g., functions that are property accesses or basic operations), sort_by_key is likely to be faster.

Current implementation

The current algorithm is based on pattern-defeating quicksort by Orson Peters, which combines the fast average case of randomized quicksort with the fast worst case of heapsort, while achieving linear time on slices with certain patterns. It uses some randomization to avoid degenerate cases, but with a fixed seed to always provide deterministic behavior.

In the worst case, the algorithm allocates temporary storage in a Vec<(K, usize)> the length of the slice.

Examples

let mut v = [-5i32, 4, 32, -3, 2];

v.sort_by_cached_key(|k| k.to_string());
assert!(v == [-3, -5, 2, 32, 4]);

pub fn to_vec(&self) -> Vec<T, Global> where
    T: Clone, 

Copies self into a new Vec.

Examples

let s = [10, 40, 30];
let x = s.to_vec();
// Here, `s` and `x` can be modified independently.

pub fn to_vec_in<A>(&self, alloc: A) -> Vec<T, A> where
    T: Clone,
    A: Allocator, 

🔬 This is a nightly-only experimental API. (allocator_api)

Copies self into a new Vec with an allocator.

Examples

#![feature(allocator_api)]

use std::alloc::System;

let s = [10, 40, 30];
let x = s.to_vec_in(System);
// Here, `s` and `x` can be modified independently.

pub fn repeat(&self, n: usize) -> Vec<T, Global> where
    T: Copy, 

Creates a vector by repeating a slice n times.

Panics

This function will panic if the capacity would overflow.

Examples

Basic usage:

assert_eq!([1, 2].repeat(3), vec![1, 2, 1, 2, 1, 2]);

A panic upon overflow:

// this will panic at runtime
b"0123456789abcdef".repeat(usize::MAX);

pub fn concat<Item>(&self) -> <[T] as Concat<Item>>::Output where
    Item: ?Sized,
    [T]: Concat<Item>, 

Flattens a slice of T into a single value Self::Output.

Examples

assert_eq!(["hello", "world"].concat(), "helloworld");
assert_eq!([[1, 2], [3, 4]].concat(), [1, 2, 3, 4]);

pub fn join<Separator>(
    &self,
    sep: Separator
) -> <[T] as Join<Separator>>::Output where
    [T]: Join<Separator>, 

Flattens a slice of T into a single value Self::Output, placing a given separator between each.

Examples

assert_eq!(["hello", "world"].join(" "), "hello world");
assert_eq!([[1, 2], [3, 4]].join(&0), [1, 2, 0, 3, 4]);
assert_eq!([[1, 2], [3, 4]].join(&[0, 0][..]), [1, 2, 0, 0, 3, 4]);

pub fn connect<Separator>(
    &self,
    sep: Separator
) -> <[T] as Join<Separator>>::Output where
    [T]: Join<Separator>, 

👎 Deprecated since 1.3.0:

renamed to join

Flattens a slice of T into a single value Self::Output, placing a given separator between each.

Examples

assert_eq!(["hello", "world"].connect(" "), "hello world");
assert_eq!([[1, 2], [3, 4]].connect(&0), [1, 2, 0, 3, 4]);

pub fn to_ascii_uppercase(&self) -> Vec<u8, Global>

Returns a vector containing a copy of this slice where each byte is mapped to its ASCII upper case equivalent.

ASCII letters ‘a’ to ‘z’ are mapped to ‘A’ to ‘Z’, but non-ASCII letters are unchanged.

To uppercase the value in-place, use make_ascii_uppercase.

pub fn to_ascii_lowercase(&self) -> Vec<u8, Global>

Returns a vector containing a copy of this slice where each byte is mapped to its ASCII lower case equivalent.

ASCII letters ‘A’ to ‘Z’ are mapped to ‘a’ to ‘z’, but non-ASCII letters are unchanged.

To lowercase the value in-place, use make_ascii_lowercase.

Trait Implementations

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Immutably borrows from an owned value.

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

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

Mutably borrows from an owned value.

impl<const N: usize> BufRead for StaticVec<u8, N>

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

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

Returns the contents of the internal buffer, filling it with more data from the inner reader if it is empty.

fn consume(&mut self, amt: usize)

Tells this buffer that amt bytes have been consumed from the buffer, so they should no longer be returned in calls to read.

pub fn read_until(
    &mut self,
    byte: u8,
    buf: &mut Vec<u8, Global>
) -> Result<usize, Error>

Read all bytes into buf until the delimiter byte or EOF is reached.

pub fn read_line(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until a newline (the 0xA byte) is reached, and append them to the provided buffer.

pub fn split(self, byte: u8) -> Split<Self>

Returns an iterator over the contents of this reader split on the byte byte.

pub fn lines(self) -> Lines<Self>

Returns an iterator over the lines of this reader.

impl<T: Clone, const N: usize> Clone for StaticVec<T, N>

default fn clone(&self) -> Self

Returns a copy of the value.

default fn clone_from(&mut self, other: &Self)

Performs copy-assignment from source.

impl<T: Copy, const N: usize> Clone for StaticVec<T, N>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, rhs: &Self)

Performs copy-assignment from source.

impl<T: Debug, const N: usize> Debug for StaticVec<T, N>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T, const N: usize> Default for StaticVec<T, N>

fn default() -> Self

Calls new.

impl<T, const N: usize> Deref for StaticVec<T, N>

type Target = [T]

The resulting type after dereferencing.

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

Dereferences the value.

impl<T, const N: usize> DerefMut for StaticVec<T, N>

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

Mutably dereferences the value.

impl<T, const N: usize> Drop for StaticVec<T, N>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: Eq, const N: usize> Eq for StaticVec<T, N>

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

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

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

pub fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<T, const N: usize> Extend<T> for StaticVec<T, N>

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

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

pub fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

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

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

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>

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

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>

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

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>

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

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>

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

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>

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

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>

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

Performs the conversion.

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

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

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>

fn from(heap: StaticHeap<T, N>) -> StaticVec<T, N>

Performs the conversion.

impl<T, const N1: usize, const N2: usize> From<StaticHeap<T, N1>> for StaticVec<T, N2>

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

Performs the conversion.

impl<const N: usize> From<StaticString<N>> for StaticVec<u8, N>

fn from(string: StaticString<N>) -> Self

Performs the conversion.

impl<const N1: usize, const N2: usize> From<StaticString<N1>> for StaticVec<u8, N2>

default fn from(string: StaticString<N1>) -> Self

Performs the conversion.

impl<T: Ord, const N: usize> From<StaticVec<T, N>> for StaticHeap<T, N>

fn from(vec: StaticVec<T, N>) -> StaticHeap<T, N>

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>

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

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>

fn from(vec: StaticVec<u8, N>) -> Self

Performs the conversion.

impl<const N1: usize, const N2: usize> From<StaticVec<u8, N1>> for StaticString<N2>

default fn from(vec: StaticVec<u8, N1>) -> Self

Performs the conversion.

impl<T, const N: usize> From<Vec<T, Global>> for StaticVec<T, N>

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

fn from(vec: Vec<T>) -> Self

Functionally equivalent to from_vec.

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

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

Creates a value from an iterator.

impl<T, const N: usize> FromIterator<T> for StaticVec<T, N>

fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Self

Creates a value from an iterator.

impl<T: Hash, const N: usize> Hash for StaticVec<T, N>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<T, const N: usize> Index<Range<usize>> for StaticVec<T, N>

type Output = [T]

The returned type after indexing.

fn index(&self, index: Range<usize>) -> &Self::Output

Asserts that the lower bound of index is less than its upper bound, and that its upper bound is less than or equal to the current length of the StaticVec, and if so returns a constant reference to a slice of elements index.start..index.end.

impl<T, const N: usize> Index<RangeFrom<usize>> for StaticVec<T, N>

type Output = [T]

The returned type after indexing.

fn index(&self, index: RangeFrom<usize>) -> &Self::Output

Asserts that the lower bound of index is less than or equal to the current length of the StaticVec, and if so returns a constant reference to a slice of elements index.start()..self.length.

impl<T, const N: usize> Index<RangeFull> for StaticVec<T, N>

type Output = [T]

The returned type after indexing.

fn index(&self, _index: RangeFull) -> &Self::Output

Returns a constant reference to a slice consisting of 0..self.length elements of the StaticVec, using as_slice internally.

impl<T, const N: usize> Index<RangeInclusive<usize>> for StaticVec<T, N>

type Output = [T]

The returned type after indexing.

fn index(&self, index: RangeInclusive<usize>) -> &Self::Output

Asserts that the lower bound of index is less than or equal to its upper bound, and that its upper bound is less than the current length of the StaticVec, and if so returns a constant reference to a slice of elements index.start()..=index.end().

impl<T, const N: usize> Index<RangeTo<usize>> for StaticVec<T, N>

type Output = [T]

The returned type after indexing.

fn index(&self, index: RangeTo<usize>) -> &Self::Output

Asserts that the upper bound of index is less than or equal to the current length of the StaticVec, and if so returns a constant reference to a slice of elements 0..index.end.

impl<T, const N: usize> Index<RangeToInclusive<usize>> for StaticVec<T, N>

type Output = [T]

The returned type after indexing.

fn index(&self, index: RangeToInclusive<usize>) -> &Self::Output

Asserts that the upper bound of index is less than the current length of the StaticVec, and if so returns a constant reference to a slice of elements 0..=index.end.

impl<T, const N: usize> Index<usize> for StaticVec<T, N>

type Output = T

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Asserts that index is less than the current length of the StaticVec, and if so returns the value at that position as a constant reference.

impl<T, const N: usize> IndexMut<Range<usize>> for StaticVec<T, N>

fn index_mut(&mut self, index: Range<usize>) -> &mut Self::Output

Asserts that the lower bound of index is less than its upper bound, and that its upper bound is less than or equal to the current length of the StaticVec, and if so returns a mutable reference to a slice of elements index.start..index.end.

impl<T, const N: usize> IndexMut<RangeFrom<usize>> for StaticVec<T, N>

fn index_mut(&mut self, index: RangeFrom<usize>) -> &mut Self::Output

Asserts that the lower bound of index is less than or equal to the current length of the StaticVec, and if so returns a mutable reference to a slice of elements index.start()..self.length.

impl<T, const N: usize> IndexMut<RangeFull> for StaticVec<T, N>

fn index_mut(&mut self, _index: RangeFull) -> &mut Self::Output

Returns a mutable reference to a slice consisting of 0..self.length elements of the StaticVec, using as_mut_slice internally.

impl<T, const N: usize> IndexMut<RangeInclusive<usize>> for StaticVec<T, N>

fn index_mut(&mut self, index: RangeInclusive<usize>) -> &mut Self::Output

Asserts that the lower bound of index is less than or equal to its upper bound, and that its upper bound is less than the current length of the StaticVec, and if so returns a mutable reference to a slice of elements index.start()..=index.end().

impl<T, const N: usize> IndexMut<RangeTo<usize>> for StaticVec<T, N>

fn index_mut(&mut self, index: RangeTo<usize>) -> &mut Self::Output

Asserts that the upper bound of index is less than or equal to the current length of the StaticVec, and if so returns a constant reference to a slice of elements 0..index.end.

impl<T, const N: usize> IndexMut<RangeToInclusive<usize>> for StaticVec<T, N>

fn index_mut(&mut self, index: RangeToInclusive<usize>) -> &mut Self::Output

Asserts that the upper bound of index is less than the current length of the StaticVec, and if so returns a constant reference to a slice of elements 0..=index.end.

impl<T, const N: usize> IndexMut<usize> for StaticVec<T, N>

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Asserts that index is less than the current length of the StaticVec, and if so returns the value at that position as a mutable reference.

impl<T, const N: usize> Into<Vec<T, Global>> for StaticVec<T, N>

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

fn into(self) -> Vec<T>

Functionally equivalent to into_vec.

impl<'a, T: 'a, const N: usize> IntoIterator for &'a StaticVec<T, N>

type IntoIter = StaticVecIterConst<'a, T, N>

Which kind of iterator are we turning this into?

type Item = &'a T

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Returns a StaticVecIterConst over the StaticVec’s inhabited area.

impl<'a, T: 'a, const N: usize> IntoIterator for &'a mut StaticVec<T, N>

type IntoIter = StaticVecIterMut<'a, T, N>

Which kind of iterator are we turning this into?

type Item = &'a mut T

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Returns a StaticVecIterMut over the StaticVec’s inhabited area.

impl<T, const N: usize> IntoIterator for StaticVec<T, N>

type IntoIter = StaticVecIntoIter<T, N>

Which kind of iterator are we turning this into?

type Item = T

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Returns a by-value StaticVecIntoIter over the StaticVec’s inhabited area, which consumes the StaticVec.

impl<T: Ord, const N: usize> Ord for StaticVec<T, N>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<T1, T2: PartialEq<T1>, const N1: usize, const N2: usize> PartialEq<&'_ [T1; N1]> for StaticVec<T2, N2>

fn eq(&self, other: &&[T1; N1]) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &&[T1; N1]) -> bool

This method tests for !=.

impl<T1, T2: PartialEq<T1>, const N: usize> PartialEq<&'_ [T1]> for StaticVec<T2, N>

fn eq(&self, other: &&[T1]) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &&[T1]) -> bool

This method tests for !=.

impl<T1, T2: PartialEq<T1>, const N1: usize, const N2: usize> PartialEq<&'_ StaticVec<T1, N1>> for StaticVec<T2, N2>

fn eq(&self, other: &&StaticVec<T1, N1>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &&StaticVec<T1, N1>) -> bool

This method tests for !=.

impl<T1, T2: PartialEq<T1>, const N1: usize, const N2: usize> PartialEq<&'_ mut [T1; N1]> for StaticVec<T2, N2>

fn eq(&self, other: &&mut [T1; N1]) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &&mut [T1; N1]) -> bool

This method tests for !=.

impl<T1, T2: PartialEq<T1>, const N: usize> PartialEq<&'_ mut [T1]> for StaticVec<T2, N>

fn eq(&self, other: &&mut [T1]) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &&mut [T1]) -> bool

This method tests for !=.

impl<T1, T2: PartialEq<T1>, const N1: usize, const N2: usize> PartialEq<&'_ mut StaticVec<T1, N1>> for StaticVec<T2, N2>

fn eq(&self, other: &&mut StaticVec<T1, N1>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &&mut StaticVec<T1, N1>) -> bool

This method tests for !=.

impl<T1, T2: PartialEq<T1>, const N1: usize, const N2: usize> PartialEq<[T1; N1]> for StaticVec<T2, N2>

fn eq(&self, other: &[T1; N1]) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &[T1; N1]) -> bool

This method tests for !=.

impl<T1, T2: PartialEq<T1>, const N1: usize, const N2: usize> PartialEq<[T1; N1]> for &StaticVec<T2, N2>

fn eq(&self, other: &[T1; N1]) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &[T1; N1]) -> bool

This method tests for !=.

impl<T1, T2: PartialEq<T1>, const N1: usize, const N2: usize> PartialEq<[T1; N1]> for &mut StaticVec<T2, N2>

fn eq(&self, other: &[T1; N1]) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &[T1; N1]) -> bool

This method tests for !=.

impl<T1, T2: PartialEq<T1>, const N: usize> PartialEq<[T1]> for StaticVec<T2, N>

fn eq(&self, other: &[T1]) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &[T1]) -> bool

This method tests for !=.

impl<T1, T2: PartialEq<T1>, const N: usize> PartialEq<[T1]> for &StaticVec<T2, N>

fn eq(&self, other: &[T1]) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &[T1]) -> bool

This method tests for !=.

impl<T1, T2: PartialEq<T1>, const N: usize> PartialEq<[T1]> for &mut StaticVec<T2, N>

fn eq(&self, other: &[T1]) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &[T1]) -> bool

This method tests for !=.

impl<T1, T2: PartialEq<T1>, const N1: usize, const N2: usize> PartialEq<StaticVec<T1, N1>> for StaticVec<T2, N2>

fn eq(&self, other: &StaticVec<T1, N1>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &StaticVec<T1, N1>) -> bool

This method tests for !=.

impl<T1, T2: PartialEq<T1>, const N1: usize, const N2: usize> PartialEq<StaticVec<T1, N1>> for &StaticVec<T2, N2>

fn eq(&self, other: &StaticVec<T1, N1>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &StaticVec<T1, N1>) -> bool

This method tests for !=.

impl<T1, T2: PartialEq<T1>, const N1: usize, const N2: usize> PartialEq<StaticVec<T1, N1>> for &mut StaticVec<T2, N2>

fn eq(&self, other: &StaticVec<T1, N1>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &StaticVec<T1, N1>) -> bool

This method tests for !=.

impl<T1, T2: PartialOrd<T1>, const N1: usize, const N2: usize> PartialOrd<&'_ [T1; N1]> for StaticVec<T2, N2>

fn partial_cmp(&self, other: &&[T1; N1]) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T1, T2: PartialOrd<T1>, const N: usize> PartialOrd<&'_ [T1]> for StaticVec<T2, N>

fn partial_cmp(&self, other: &&[T1]) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T1, T2: PartialOrd<T1>, const N1: usize, const N2: usize> PartialOrd<&'_ StaticVec<T1, N1>> for StaticVec<T2, N2>

fn partial_cmp(&self, other: &&StaticVec<T1, N1>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T1, T2: PartialOrd<T1>, const N1: usize, const N2: usize> PartialOrd<&'_ mut [T1; N1]> for StaticVec<T2, N2>

fn partial_cmp(&self, other: &&mut [T1; N1]) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T1, T2: PartialOrd<T1>, const N: usize> PartialOrd<&'_ mut [T1]> for StaticVec<T2, N>

fn partial_cmp(&self, other: &&mut [T1]) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T1, T2: PartialOrd<T1>, const N1: usize, const N2: usize> PartialOrd<&'_ mut StaticVec<T1, N1>> for StaticVec<T2, N2>

fn partial_cmp(&self, other: &&mut StaticVec<T1, N1>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T1, T2: PartialOrd<T1>, const N1: usize, const N2: usize> PartialOrd<[T1; N1]> for StaticVec<T2, N2>

fn partial_cmp(&self, other: &[T1; N1]) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T1, T2: PartialOrd<T1>, const N1: usize, const N2: usize> PartialOrd<[T1; N1]> for &StaticVec<T2, N2>

fn partial_cmp(&self, other: &[T1; N1]) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T1, T2: PartialOrd<T1>, const N1: usize, const N2: usize> PartialOrd<[T1; N1]> for &mut StaticVec<T2, N2>

fn partial_cmp(&self, other: &[T1; N1]) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T1, T2: PartialOrd<T1>, const N: usize> PartialOrd<[T1]> for StaticVec<T2, N>

fn partial_cmp(&self, other: &[T1]) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T1, T2: PartialOrd<T1>, const N: usize> PartialOrd<[T1]> for &StaticVec<T2, N>

fn partial_cmp(&self, other: &[T1]) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T1, T2: PartialOrd<T1>, const N: usize> PartialOrd<[T1]> for &mut StaticVec<T2, N>

fn partial_cmp(&self, other: &[T1]) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T1, T2: PartialOrd<T1>, const N1: usize, const N2: usize> PartialOrd<StaticVec<T1, N1>> for StaticVec<T2, N2>

fn partial_cmp(&self, other: &StaticVec<T1, N1>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T1, T2: PartialOrd<T1>, const N1: usize, const N2: usize> PartialOrd<StaticVec<T1, N1>> for &StaticVec<T2, N2>

fn partial_cmp(&self, other: &StaticVec<T1, N1>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T1, T2: PartialOrd<T1>, const N1: usize, const N2: usize> PartialOrd<StaticVec<T1, N1>> for &mut StaticVec<T2, N2>

fn partial_cmp(&self, other: &StaticVec<T1, N1>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<const N: usize> Read for StaticVec<u8, N>

Read from a StaticVec. This implementation operates by copying bytes into the destination buffers, then shifting the remaining bytes over.

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

unsafe fn initializer(&self) -> Initializer

🔬 This is a nightly-only experimental API. (read_initializer)

Determines if this Reader can work with buffers of uninitialized memory.

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize>

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize>

Read all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<()>

Read the exact number of bytes required to fill buf.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize>

Like read, except that it reads into a slice of buffers.

pub fn is_read_vectored(&self) -> bool

🔬 This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

pub fn by_ref(&mut self) -> &mut Self

Creates a “by reference” adaptor for this instance of Read.

pub fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an Iterator over its bytes.

pub fn chain<R>(self, next: R) -> Chain<Self, R> where
    R: Read, 

Creates an adaptor which will chain this stream with another.

pub fn take(self, limit: u64) -> Take<Self>

Creates an adaptor which will read at most limit bytes from it.

impl<const N: usize> Write for StaticVec<u8, N>

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

fn write(&mut self, buf: &[u8]) -> Result<usize>

Write a buffer into this writer, returning how many bytes were written.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize>

Like write, except that it writes from a slice of buffers.

fn write_all(&mut self, buf: &[u8]) -> Result<()>

Attempts to write an entire buffer into this writer.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

pub fn is_write_vectored(&self) -> bool

🔬 This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

pub fn write_all_vectored(
    &mut self,
    bufs: &mut [IoSlice<'_>]
) -> Result<(), Error>

🔬 This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

pub fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

pub fn by_ref(&mut self) -> &mut Self

Creates a “by reference” adaptor for this instance of Write.