Struct TiVec

Source

#[repr(transparent)]pub struct TiVec<K, V> {
    pub raw: Vec<V>,
    /* private fields */
}

Available on crate feature alloc only.

Expand description

A contiguous growable array type that only accepts keys of the type K.

TiVec<K, V> is a wrapper around Rust container type std::vec::Vec. The struct mirrors the stable API of Rust std::vec::Vec and forwards to it as much as possible.

TiVec<K, V> uses K instead of usize for element indices and require the index to implement From<usize> and Into<usize> traits. Their implementation can be easily done with derive_more crate and #[derive(From, Into)].

TiVec<K, V> can be converted to std::vec::Vec<V> and back using From and Into.

There are also zero-cost conversions available between references:

&std::vec::Vec<V> and &TiVec<K, V> with AsRef,
&mut std::vec::Vec<V> and &mut TiVec<K, V> with AsMut,

Added methods:

from_ref - Converts a &std::vec::Vec<V> into a &TiVec<K, V>.
from_mut - Converts a &mut std::vec::Vec<V> into a &mut TiVec<K, V>.
push_and_get_key - Appends an element to the back of a collection and returns its index of type K.
pop_key_value - Removes the last element from a vector and returns it with its index of type K, or None if the vector is empty.
drain_enumerated - Creates a draining iterator that removes the specified range in the vector and yields the current count and the removed items. It acts like self.drain(range).enumerate(), but instead of usize it returns index of type K.
into_iter_enumerated - Converts the vector into iterator over all key-value pairs with K used for iteration indices. It acts like self.into_iter().enumerate(), but use K instead of usize for iteration indices.

§Example

use derive_more::{From, Into};
use typed_index_collections::TiVec;

#[derive(From, Into)]
struct FooId(usize);

let mut foos: TiVec<FooId, usize> = std::vec![10, 11, 13].into();
foos.insert(FooId(2), 12);
assert_eq!(foos[FooId(2)], 12);

Fields§

§raw: Vec<V>

Raw slice property

Implementations§

Source §

impl<K, V> TiVec<K, V>

Source

pub const fn new() -> Self

Constructs a new, empty TiVec<K, V>.

See Vec::new for more details.

Source

pub fn with_capacity(capacity: usize) -> Self

Constructs a new, empty TiVec<K, V> with the specified capacity.

See Vec::with_capacity for more details.

Source

pub unsafe fn from_raw_parts( ptr: *mut V, length: usize, capacity: usize, ) -> Self

Creates a TiVec<K, V> directly from the raw components of another vector.

See Vec::from_raw_parts for more details.

§Safety

This is highly unsafe, due to the number of invariants that aren’t checked. See Vec::from_raw_parts for more details.

Source

pub const fn from_ref(raw: &Vec<V>) -> &Self

Converts a &std::vec::Vec<V> into a &TiVec<K, V>.

Vector reference is intentionally used in the argument instead of slice reference for conversion with no-op.

§Example

pub struct Id(usize);
let vec: &TiVec<Id, usize> = TiVec::from_ref(&vec![1, 2, 4]);

Source

pub fn from_mut(raw: &mut Vec<V>) -> &mut Self

Converts a &mut std::vec::Vec<V> into a &mut TiVec<K, V>.

§Example

pub struct Id(usize);
let vec: &mut TiVec<Id, usize> = TiVec::from_mut(&mut vec![1, 2, 4]);

Source

pub fn capacity(&self) -> usize

Returns the number of elements the vector can hold without reallocating.

See Vec::capacity for more details.

Source

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

Reserves capacity for at least additional more elements to be inserted in the given TiVec<K, V>. The collection may reserve more space to avoid frequent reallocations. After calling reserve, capacity will be greater than or equal to self.len() + additional. Does nothing if capacity is already sufficient.

See Vec::reserve for more details.

Source

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

Reserves the minimum capacity for exactly additional more elements to be inserted in the given TiVec<K, V>. After calling reserve_exact, capacity will be greater than or equal to self.len() + additional. Does nothing if the capacity is already sufficient.

See Vec::reserve_exact for more details.

Source

pub fn try_reserve(&mut self, additional: usize) -> Result<(), TryReserveError>

Tries to reserve capacity for at least additional more elements to be inserted in the given Vec<T>.

See Vec::try_reserve for more details.

§Errors

If the capacity overflows, or the allocator reports a failure, then an error is returned.

Source

pub fn try_reserve_exact( &mut self, additional: usize, ) -> Result<(), TryReserveError>

Tries to reserve the minimum capacity for at least additional elements to be inserted in the given Vec<T>.

See Vec::try_reserve_exact for more details.

§Errors

If the capacity overflows, or the allocator reports a failure, then an error is returned.

Source

pub fn shrink_to_fit(&mut self)

Shrinks the capacity of the vector as much as possible.

See Vec::shrink_to_fit for more details.

Source

pub fn shrink_to(&mut self, min_capacity: usize)

Shrinks the capacity of the vector with a lower bound.

See Vec::shrink_to for more details.

Source

pub fn into_boxed_slice(self) -> Box<TiSlice<K, V>>

Converts the vector into Box<TiSlice<K, V>>.

See Vec::into_boxed_slice for more details.

Source

pub fn truncate(&mut self, len: usize)

Shortens the vector, keeping the first len elements and dropping the rest.

See Vec::truncate for more details.

Source

pub fn as_slice(&self) -> &TiSlice<K, V>

Extracts a slice containing the entire vector.

See Vec::as_slice for more details.

Source

pub fn as_mut_slice(&mut self) -> &mut TiSlice<K, V>

Extracts a mutable slice of the entire vector.

See Vec::as_mut_slice for more details.

Source

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

Returns a raw pointer to the vector’s buffer.

See Vec::as_ptr for more details.

Source

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

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

See Vec::as_mut_ptr for more details.

Source

pub unsafe fn set_len(&mut self, new_len: usize)

Forces the length of the vector to new_len.

See Vec::set_len for more details.

§Safety

new_len must be less than or equal to capacity().
The elements at old_len..new_len must be initialized.

Source

pub fn swap_remove(&mut self, index: K) -> V
where usize: From<K>,

Removes an element from the vector and returns it.

The removed element is replaced by the last element of the vector.

See Vec::swap_remove for more details.

Source

pub fn insert(&mut self, index: K, element: V)
where usize: From<K>,

Inserts an element at position index within the vector, shifting all elements after it to the right.

See Vec::insert for more details.

Source

pub fn remove(&mut self, index: K) -> V
where usize: From<K>,

Removes and returns the element at position index within the vector, shifting all elements after it to the left.

See Vec::remove for more details.

Source

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

Retains only the elements specified by the predicate.

See Vec::retain for more details.

Source

pub fn retain_mut<F>(&mut self, f: F)
where F: FnMut(&mut V) -> bool,

Retains only the elements specified by the predicate, passing a mutable reference to it.

See Vec::retain_mut for more details.

Source

pub fn dedup_by_key<F, K2>(&mut self, key: F)
where F: FnMut(&mut V) -> K2, K2: PartialEq,

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

See Vec::dedup_by_key for more details.

Source

pub fn dedup_by<F>(&mut self, same_bucket: F)
where F: FnMut(&mut V, &mut V) -> bool,

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

See Vec::dedup_by for more details.

Source

pub fn push(&mut self, value: V)

Appends an element to the back of a collection.

See Vec::push for more details.

Source

pub fn push_and_get_key(&mut self, value: V) -> K
where K: From<usize>,

Appends an element to the back of a collection and returns its index of type K.

It acts like { vec.push(...); vec.last_key().unwrap() }, but is optimized better.

See Vec::push for more details.

§Example

#[derive(Eq, Debug, From, Into, PartialEq)]
pub struct Id(usize);
let mut vec: TiVec<Id, usize> = vec![1, 2, 4].into();
assert_eq!(vec.push_and_get_key(8), Id(3));
assert_eq!(vec.push_and_get_key(16), Id(4));
assert_eq!(vec.push_and_get_key(32), Id(5));

Source

pub fn pop(&mut self) -> Option<V>

Removes the last element from a vector and returns it, or None if it is empty.

See Vec::pop for more details.

Source

pub fn pop_key_value(&mut self) -> Option<(K, V)>
where K: From<usize>,

Removes the last element from a vector and returns it with its index of type K, or None if the vector is empty.

See Vec::pop for more details.

§Example

#[derive(Eq, Debug, From, Into, PartialEq)]
pub struct Id(usize);
let mut vec: TiVec<Id, usize> = vec![1, 2, 4].into();
assert_eq!(vec.pop_key_value(), Some((Id(2), 4)));
assert_eq!(vec.pop_key_value(), Some((Id(1), 2)));
assert_eq!(vec.pop_key_value(), Some((Id(0), 1)));
assert_eq!(vec.pop_key_value(), None);

Source

pub fn append(&mut self, other: &mut Self)

Moves all the elements of other into Self, leaving other empty.

See Vec::append for more details.

Source

pub fn drain<R>(&mut self, range: R) -> Drain<'_, V> ⓘ
where R: TiRangeBounds<K>,

Creates a draining iterator that removes the specified range in the vector and yields the removed items.

See Vec::drain for more details.

Source

pub fn drain_enumerated<R>( &mut self, range: R, ) -> TiEnumerated<Drain<'_, V>, K, V>
where K: From<usize>, R: TiRangeBounds<K>,

Creates a draining iterator that removes the specified range in the vector and yields the current count and the removed items.

It acts like self.drain(range).enumerate(), but instead of usize it returns index of type K.

Note that the indices started from K::from_usize(0), regardless of the range starting point.

See Vec::drain for more details.

§Example

#[derive(Eq, Debug, From, Into, PartialEq)]
pub struct Id(usize);
let mut vec: TiVec<Id, usize> = vec![1, 2, 4].into();
{
    let mut iterator = vec.drain_enumerated(Id(1)..);
    assert_eq!(iterator.next(), Some((Id(0), 2)));
    assert_eq!(iterator.next(), Some((Id(1), 4)));
    assert_eq!(iterator.next(), None);
}
assert_eq!(vec.as_slice(), TiSlice::from_ref(&[1]));

Source

pub fn clear(&mut self)

Clears the vector, removing all values.

See Vec::clear for more details.

Source

pub fn len(&self) -> usize

Returns the number of elements in the vector, also referred to as its ‘length’.

See Vec::len for more details.

Source

pub fn is_empty(&self) -> bool

Returns true if the vector contains no elements.

See Vec::is_empty for more details.

Source

pub fn split_off(&mut self, at: K) -> Self
where usize: From<K>,

Splits the collection into two at the given index.

See Vec::split_off for more details.

Source

pub fn resize_with<F>(&mut self, new_len: usize, f: F)
where F: FnMut() -> V,

Resizes the TiVec in-place so that len is equal to new_len.

See Vec::resize_with for more details.

Source

pub fn resize(&mut self, new_len: usize, value: V)
where V: Clone,

Resizes the TiVec in-place so that len is equal to new_len.

See Vec::resize for more details.

Source

pub fn leak<'a>(self) -> &'a mut TiSlice<K, V>

Consumes and leaks the Vec, returning a mutable reference to the contents, &'a mut [T]. Note that the type T must outlive the chosen lifetime 'a. If the type has only static references, or none at all, then this may be chosen to be 'static.

See Vec::leak for more details.

Source

pub fn spare_capacity_mut(&mut self) -> &mut TiSlice<K, MaybeUninit<V>>

Returns the remaining spare capacity of the vector as a slice of MaybeUninit<T>.

See Vec::spare_capacity_mut for more details.

Source

pub fn extend_from_slice(&mut self, other: &TiSlice<K, V>)
where V: Clone,

Clones and appends all elements in a slice to the TiVec.

See Vec::extend_from_slice for more details.

Source

pub fn extend_from_within<R>(&mut self, src: R)
where V: Clone, R: RangeBounds<usize>,

Copies elements from src range to the end of the vector.

See Vec::extend_from_within for more details.

§Panics

Panics if the starting point is greater than the end point or if the end point is greater than the length of the vector.

Source

pub fn dedup(&mut self)
where V: PartialEq,

Removes consecutive repeated elements in the vector according to the PartialEq trait implementation.

See Vec::dedup for more details.

Source

pub fn splice<R, I>( &mut self, range: R, replace_with: I, ) -> Splice<'_, I::IntoIter> ⓘ
where R: TiRangeBounds<K>, I: IntoIterator<Item = V>,

Creates a splicing iterator that replaces the specified range in the vector with the given replace_with iterator and yields the removed items. replace_with does not need to be the same length as range.

See Vec::splice for more details.

Source

pub fn into_iter_enumerated(self) -> TiEnumerated<IntoIter<V>, K, V>
where K: From<usize>,

Converts the vector into iterator over all key-value pairs with K used for iteration indices.

It acts like self.into_iter().enumerate(), but use K instead of usize for iteration indices.

§Example

#[derive(Eq, Debug, From, Into, PartialEq)]
pub struct Id(usize);
let vec: TiVec<Id, usize> = vec![1, 2, 4].into();
let mut iterator = vec.into_iter_enumerated();
assert_eq!(iterator.next(), Some((Id(0), 1)));
assert_eq!(iterator.next(), Some((Id(1), 2)));
assert_eq!(iterator.next(), Some((Id(2), 4)));
assert_eq!(iterator.next(), None);

Methods from Deref<Target = TiSlice<K, V>>§

Source

pub fn len(&self) -> usize

Returns the number of elements in the slice.

See slice::len for more details.

Source

pub fn next_key(&self) -> K
where K: From<usize>,

Returns the index of the next slice element to be appended and at the same time number of elements in the slice of type K.

§Example

#[derive(Eq, Debug, From, Into, PartialEq)]
pub struct Id(usize);
let slice: &TiSlice<Id, usize> = TiSlice::from_ref(&[1, 2, 4]);
assert_eq!(slice.next_key(), Id(3));

Source

pub fn is_empty(&self) -> bool

Returns true if the slice has a length of 0.

See slice::is_empty for more details.

Source

pub fn keys(&self) -> TiSliceKeys<K>
where K: From<usize>,

Returns an iterator over all keys.

§Example

#[derive(Debug, Eq, From, Into, PartialEq)]
pub struct Id(usize);
let slice: &TiSlice<Id, usize> = TiSlice::from_ref(&[1, 2, 4]);
let mut iterator = slice.keys();
assert_eq!(iterator.next(), Some(Id(0)));
assert_eq!(iterator.next(), Some(Id(1)));
assert_eq!(iterator.next(), Some(Id(2)));
assert_eq!(iterator.next(), None);

Source

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

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

See slice::first for more details.

Source

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

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

See slice::first_mut for more details.

Source

pub fn first_key(&self) -> Option<K>
where K: From<usize>,

Returns the first slice element index of type K, or None if the slice is empty.

§Example

#[derive(Debug, Eq, From, Into, PartialEq)]
pub struct Id(usize);
let empty_slice: &TiSlice<Id, usize> = TiSlice::from_ref(&[]);
let slice: &TiSlice<Id, usize> = TiSlice::from_ref(&[1, 2, 4]);
assert_eq!(empty_slice.first_key(), None);
assert_eq!(slice.first_key(), Some(Id(0)));

Source

pub fn first_key_value(&self) -> Option<(K, &V)>
where K: From<usize>,

Returns the first slice element index of type K and the element itself, or None if the slice is empty.

See slice::first for more details.

§Example

#[derive(Debug, Eq, From, Into, PartialEq)]
pub struct Id(usize);
let empty_slice: &TiSlice<Id, usize> = TiSlice::from_ref(&[]);
let slice: &TiSlice<Id, usize> = TiSlice::from_ref(&[1, 2, 4]);
assert_eq!(empty_slice.first_key_value(), None);
assert_eq!(slice.first_key_value(), Some((Id(0), &1)));

Source

pub fn first_key_value_mut(&mut self) -> Option<(K, &mut V)>
where K: From<usize>,

Returns the first slice element index of type K and a mutable reference to the element itself, or None if the slice is empty.

See slice::first_mut for more details.

§Example

#[derive(Debug, Eq, From, Into, PartialEq)]
pub struct Id(usize);
let empty_slice: &mut TiSlice<Id, usize> = TiSlice::from_mut(&mut []);
let mut array = [1, 2, 4];
let slice: &mut TiSlice<Id, usize> = TiSlice::from_mut(&mut array);
assert_eq!(empty_slice.first_key_value_mut(), None);
assert_eq!(slice.first_key_value_mut(), Some((Id(0), &mut 1)));
*slice.first_key_value_mut().unwrap().1 = 123;
assert_eq!(slice.raw, [123, 2, 4]);

Source

pub fn split_first(&self) -> Option<(&V, &Self)>

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

See slice::split_first for more details.

Source

pub fn split_first_mut(&mut self) -> Option<(&mut V, &mut Self)>

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

See slice::split_first_mut for more details.

Source

pub fn split_last(&self) -> Option<(&V, &Self)>

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

See slice::split_last for more details.

Source

pub fn split_last_mut(&mut self) -> Option<(&mut V, &mut Self)>

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

See slice::split_last_mut for more details.

Source

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

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

See slice::last for more details.

Source

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

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

See slice::last_mut for more details.

Source

pub fn last_key(&self) -> Option<K>
where K: From<usize>,

Returns the last slice element index of type K, or None if the slice is empty.

§Example

#[derive(Debug, Eq, From, Into, PartialEq)]
pub struct Id(usize);
let empty_slice: &TiSlice<Id, usize> = TiSlice::from_ref(&[]);
let slice: &TiSlice<Id, usize> = TiSlice::from_ref(&[1, 2, 4]);
assert_eq!(empty_slice.last_key(), None);
assert_eq!(slice.last_key(), Some(Id(2)));

Source

pub fn last_key_value(&self) -> Option<(K, &V)>
where K: From<usize>,

Returns the last slice element index of type K and the element itself, or None if the slice is empty.

See slice::last for more details.

§Example

#[derive(Debug, Eq, From, Into, PartialEq)]
pub struct Id(usize);
let empty_slice: &TiSlice<Id, usize> = TiSlice::from_ref(&[]);
let slice: &TiSlice<Id, usize> = TiSlice::from_ref(&[1, 2, 4]);
assert_eq!(empty_slice.last_key_value(), None);
assert_eq!(slice.last_key_value(), Some((Id(2), &4)));

Source

pub fn last_key_value_mut(&mut self) -> Option<(K, &mut V)>
where K: From<usize>,

Returns the last slice element index of type K and a mutable reference to the element itself, or None if the slice is empty.

See slice::last_mut for more details.

§Example

#[derive(Debug, Eq, From, Into, PartialEq)]
pub struct Id(usize);
let empty_slice: &mut TiSlice<Id, usize> = TiSlice::from_mut(&mut []);
let mut array = [1, 2, 4];
let slice: &mut TiSlice<Id, usize> = TiSlice::from_mut(&mut array);
assert_eq!(empty_slice.last_key_value_mut(), None);
assert_eq!(slice.last_key_value_mut(), Some((Id(2), &mut 4)));
*slice.last_key_value_mut().unwrap().1 = 123;
assert_eq!(slice.raw, [1, 2, 123]);

Source

pub fn get(&self, index: I) -> Option<&I::Output>
where I: TiSliceIndex<K, V>,

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

See slice::get for more details.

Source

pub fn get_mut(&mut self, index: I) -> Option<&mut I::Output>
where I: TiSliceIndex<K, V>,

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

See slice::get_mut for more details.

Source

pub unsafe fn get_unchecked(&self, index: I) -> &I::Output
where I: TiSliceIndex<K, V>,

Returns a reference to an element or subslice depending on the type of index, without doing bounds checking.

See slice::get_unchecked for more details.

§Safety

Calling this method with an out-of-bounds index is undefined behavior even if the resulting reference is not used. For a safe alternative see get.

Source

pub unsafe fn get_unchecked_mut(&mut self, index: I) -> &mut I::Output
where I: TiSliceIndex<K, V>,

Returns a mutable reference to an element or subslice depending on the type of index, without doing bounds checking.

See slice::get_unchecked_mut for more details.

§Safety

Calling this method with an out-of-bounds index is undefined behavior even if the resulting reference is not used. For a safe alternative see get_mut.

Source

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

Returns a raw pointer to the slice’s buffer.

See slice::as_ptr for more details.

Source

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

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

See slice::as_mut_ptr for more details.

Source

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

Returns the two raw pointers spanning the slice.

See slice::as_ptr_range for more details.

Source

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

Returns the two unsafe mutable pointers spanning the slice.

See slice::as_mut_ptr_range for more details.

Source

pub fn swap(&mut self, a: K, b: K)
where usize: From<K>,

Swaps two elements in the slice.

See slice::swap for more details.

Source

pub fn reverse(&mut self)

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

See slice::reverse for more details.

Source

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

Returns an iterator over the slice.

See slice::iter for more details.

Source

pub fn iter_enumerated(&self) -> TiEnumerated<Iter<'_, V>, K, &V>
where K: From<usize>,

Returns an iterator over all key-value pairs.

It acts like self.iter().enumerate(), but use K instead of usize for iteration indices.

See slice::iter for more details.

§Example

#[derive(Debug, Eq, From, Into, PartialEq)]
pub struct Id(usize);
let slice: &TiSlice<Id, usize> = TiSlice::from_ref(&[1, 2, 4]);
let mut iterator = slice.iter_enumerated();
assert_eq!(iterator.next(), Some((Id(0), &1)));
assert_eq!(iterator.next(), Some((Id(1), &2)));
assert_eq!(iterator.next(), Some((Id(2), &4)));
assert_eq!(iterator.next(), None);

Source

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

Returns an iterator that allows modifying each value.

See slice::iter_mut for more details.

Source

pub fn iter_mut_enumerated(&mut self) -> TiEnumerated<IterMut<'_, V>, K, &mut V>
where K: From<usize>,

Returns an iterator over all key-value pairs, with mutable references to the values.

It acts like self.iter_mut().enumerate(), but use K instead of usize for iteration indices.

§Example

#[derive(Debug, Eq, From, Into, PartialEq)]
pub struct Id(usize);
let mut array = [1, 2, 4];
let slice: &mut TiSlice<Id, usize> = TiSlice::from_mut(&mut array);
for (key, value) in slice.iter_mut_enumerated() {
    *value += key.0;
}
assert_eq!(array, [1, 3, 6]);

Source

pub fn position(&self, predicate: P) -> Option<K>
where K: From<usize>, P: FnMut(&V) -> bool,

Searches for an element in an iterator, returning its index of type K.

It acts like self.iter().position(...), but instead of usize it returns index of type K.

See slice::iter and Iterator::position for more details.

§Example

#[derive(Debug, Eq, From, Into, PartialEq)]
pub struct Id(usize);
let slice: &TiSlice<Id, usize> = TiSlice::from_ref(&[1, 2, 4, 2, 1]);
assert_eq!(slice.position(|&value| value == 1), Some(Id(0)));
assert_eq!(slice.position(|&value| value == 2), Some(Id(1)));
assert_eq!(slice.position(|&value| value == 3), None);
assert_eq!(slice.position(|&value| value == 4), Some(Id(2)));

Source

pub fn rposition(&self, predicate: P) -> Option<K>
where K: From<usize>, P: FnMut(&V) -> bool,

Searches for an element in an iterator from the right, returning its index of type K.

It acts like self.iter().rposition(...), but instead of usize it returns index of type K.

See slice::iter and Iterator::rposition for more details.

§Example

#[derive(Debug, Eq, From, Into, PartialEq)]
pub struct Id(usize);
let slice: &TiSlice<Id, usize> = TiSlice::from_ref(&[1, 2, 4, 2, 1]);
assert_eq!(slice.rposition(|&value| value == 1), Some(Id(4)));
assert_eq!(slice.rposition(|&value| value == 2), Some(Id(3)));
assert_eq!(slice.rposition(|&value| value == 3), None);
assert_eq!(slice.rposition(|&value| value == 4), Some(Id(2)));

Source

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

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.

See slice::windows for more details.

Source

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

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

See slice::chunks for more details.

Source

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

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

See slice::chunks_mut for more details.

Source

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

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

See slice::chunks_exact for more details.

Source

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

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

See slice::chunks_exact_mut for more details.

Source

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

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

See slice::rchunks for more details.

Source

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

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

See slice::rchunks_mut for more details.

Source

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

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

See slice::rchunks_exact for more details.

Source

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

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

See slice::rchunks_exact_mut for more details.

Source

pub fn chunk_by<F>(&self, pred: F) -> TiSliceRefMap<ChunkBy<'_, V, F>, K, V>
where F: FnMut(&V, &V) -> bool,

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

See slice::chunk_by for more details.

Source

pub fn chunk_by_mut<F>( &mut self, pred: F, ) -> TiSliceMutMap<ChunkByMut<'_, V, F>, K, V>
where F: FnMut(&V, &V) -> bool,

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

See slice::chunk_by_mut for more details.

Source

pub fn split_at(&self, mid: K) -> (&Self, &Self)
where usize: From<K>,

Divides one slice into two at an index.

See slice::split_at for more details.

Source

pub fn split_at_mut(&mut self, mid: K) -> (&mut Self, &mut Self)
where usize: From<K>,

Divides one mutable slice into two at an index.

See slice::split_at_mut for more details.

Source

pub unsafe fn split_at_unchecked(&self, mid: K) -> (&Self, &Self)
where usize: From<K>,

Divides one slice into two at an index, without doing bounds checking.

See slice::split_at_unchecked for more details.

§Safety

Calling this method with an out-of-bounds index is undefined behavior even if the resulting reference is not used. The caller has to ensure that 0 <= mid <= self.len().

Source

pub unsafe fn split_at_mut_unchecked( &mut self, mid: K, ) -> (&mut Self, &mut Self)
where usize: From<K>,

Divides one mutable slice into two at an index, without doing bounds checking.

See slice::split_at_mut_unchecked for more details.

§Safety

Calling this method with an out-of-bounds index is undefined behavior even if the resulting reference is not used. The caller has to ensure that 0 <= mid <= self.len().

Source

pub fn split_at_checked(&self, mid: K) -> Option<(&Self, &Self)>
where usize: From<K>,

Divides one slice into two at an index, returning None if the slice is too short.

See slice::split_at_checked for more details.

Source

pub fn split_at_mut_checked(&mut self, mid: K) -> Option<(&mut Self, &mut Self)>
where usize: From<K>,

Divides one mutable slice into two at an index, returning None if the slice is too short.

See slice::split_at_mut_checked for more details.

Source

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

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

See slice::split for more details.

Source

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

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

See slice::split_mut for more details.

Source

pub fn split_inclusive<F>( &self, pred: F, ) -> TiSliceRefMap<SplitInclusive<'_, V, F>, K, V>
where F: FnMut(&V) -> 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.

See slice::split_inclusive for more details.

Source

pub fn split_inclusive_mut<F>( &mut self, pred: F, ) -> TiSliceMutMap<SplitInclusiveMut<'_, V, F>, K, V>
where F: FnMut(&V) -> 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.

See slice::split_inclusive_mut for more details.

Source

pub fn rsplit<F>(&self, pred: F) -> TiSliceRefMap<RSplit<'_, V, F>, K, V>
where F: FnMut(&V) -> 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.

See slice::rsplit for more details.

Source

pub fn rsplit_mut<F>( &mut self, pred: F, ) -> TiSliceMutMap<RSplitMut<'_, V, F>, K, V>
where F: FnMut(&V) -> 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.

See slice::rsplit_mut for more details.

Source

pub fn splitn<F>( &self, n: usize, pred: F, ) -> TiSliceRefMap<SplitN<'_, V, F>, K, V>
where F: FnMut(&V) -> 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.

See slice::splitn for more details.

Source

pub fn splitn_mut<F>( &mut self, n: usize, pred: F, ) -> TiSliceMutMap<SplitNMut<'_, V, F>, K, V>
where F: FnMut(&V) -> 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.

See slice::splitn_mut for more details.

Source

pub fn rsplitn<F>( &self, n: usize, pred: F, ) -> TiSliceRefMap<RSplitN<'_, V, F>, K, V>
where F: FnMut(&V) -> 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.

See slice::rsplitn for more details.

Source

pub fn rsplitn_mut<F>( &mut self, n: usize, pred: F, ) -> TiSliceMutMap<RSplitNMut<'_, V, F>, K, V>
where F: FnMut(&V) -> 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.

See slice::rsplitn_mut for more details.

Source

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

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

See slice::contains for more details.

Source

pub fn starts_with(&self, needle: &Self) -> bool
where V: PartialEq,

Returns true if needle is a prefix of the slice.

See slice::starts_with for more details.

Source

pub fn ends_with(&self, needle: &Self) -> bool
where V: PartialEq,

Returns true if needle is a suffix of the slice.

See slice::ends_with for more details.

Source

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

Binary searches this sorted slice for a given element.

See slice::binary_search for more details.

Source

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

Binary searches this sorted slice with a comparator function.

See slice::binary_search_by for more details.

Source

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

Binary searches this sorted slice with a key extraction function.

See slice::binary_search_by_key for more details.

Source

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

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

See slice::sort_unstable for more details.

Source

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

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

See slice::sort_unstable_by for more details.

Source

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

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

See slice::sort_unstable_by_key for more details.

Source

pub fn select_nth_unstable( &mut self, index: K, ) -> (&mut Self, &mut V, &mut Self)
where usize: From<K>, V: Ord,

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

See slice::select_nth_unstable for more details.

§Panics

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

May panic if the implementation of Ord for T does not implement a [total order].

Source

pub fn select_nth_unstable_by<F>( &mut self, index: K, compare: F, ) -> (&mut Self, &mut V, &mut Self)
where usize: From<K>, F: FnMut(&V, &V) -> Ordering,

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

See slice::select_nth_unstable_by for more details.

§Panics

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

May panic if compare does not implement a [total order].

Source

pub fn select_nth_unstable_by_key<Key, F>( &mut self, index: K, f: F, ) -> (&mut Self, &mut V, &mut Self)
where usize: From<K>, F: FnMut(&V) -> Key, Key: Ord,

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

See slice::select_nth_unstable_by_key for more details.

§Panics

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

May panic if K: Ord does not implement a total order.

Source

pub fn rotate_left(&mut self, mid: K)
where usize: From<K>,

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

See slice::rotate_left for more details.

Source

pub fn rotate_right(&mut self, k: K)
where usize: From<K>,

Rotates the slice in-place such that the first self.next_key() - 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.next_key() - k will become the first element in the slice.

See slice::rotate_right for more details.

Source

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

Fills self with elements by cloning value.

See slice::fill for more details.

Source

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

Fills self with elements returned by calling a closure repeatedly.

See slice::fill_with for more details.

Source

pub fn clone_from_slice(&mut self, src: &Self)
where V: Clone,

Copies the elements from src into self.

See slice::clone_from_slice for more details.

Source

pub fn copy_from_slice(&mut self, src: &Self)
where V: Copy,

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

See slice::copy_from_slice for more details.

Source

pub fn copy_within<R>(&mut self, src: R, dest: K)
where R: TiRangeBounds<K>, V: Copy, usize: From<K>,

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

See slice::copy_within for more details.

Source

pub fn swap_with_slice(&mut self, other: &mut Self)

Swaps all elements in self with those in other.

See slice::swap_with_slice for more details.

Source

pub unsafe fn align_to(&self) -> (&Self, &TiSlice<K, U>, &Self)

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

See slice::align_to for more details.

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

Source

pub unsafe fn align_to_mut( &mut self, ) -> (&mut Self, &mut TiSlice<K, U>, &mut Self)

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

See slice::align_to_mut for more details.

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

Source

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

Checks if the elements of this slice are sorted.

See slice::is_sorted for more details.

Source

pub fn is_sorted_by<'a, F>(&'a self, compare: F) -> bool
where F: FnMut(&'a V, &'a V) -> bool,

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

See slice::is_sorted_by for more details.

Source

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

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

See slice::is_sorted_by_key for more details.

Source

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

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

See slice::partition_point for more details.

Source

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

Sorts the slice.

See slice::sort for more details.

Source

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

Sorts the slice with a comparator function.

See slice::sort_by for more details.

Source

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

Sorts the slice with a key extraction function.

See slice::sort_by_key for more details.

Source

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

Sorts the slice with a key extraction function.

See slice::sort_by_cached_key for more details.

Source

pub fn to_vec(&self) -> TiVec<K, V>
where V: Clone,

Copies self into a new TiVec.

See slice::to_vec for more details.

Source

pub fn repeat(&self, n: usize) -> TiVec<K, V>
where V: Copy,

Creates a vector by repeating a slice n times.

See slice::repeat for more details.

Source

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

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

See slice::concat for more details.

Source

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

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

See slice::join for more details.

Trait Implementations§

Source §

impl<K, V> AsMut<[V]> for TiVec<K, V>

Source §

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

Converts this type into a mutable reference of the (usually inferred) input type.

Source §

impl<K, V> AsMut<TiSlice<K, V>> for TiVec<K, V>

Source §

fn as_mut(&mut self) -> &mut TiSlice<K, V>

Converts this type into a mutable reference of the (usually inferred) input type.

Source §

impl<K, V> AsMut<TiVec<K, V>> for TiVec<K, V>

Source §

fn as_mut(&mut self) -> &mut Self

Converts this type into a mutable reference of the (usually inferred) input type.

Source §

impl<K, V> AsMut<TiVec<K, V>> for Vec<V>

Source §

fn as_mut(&mut self) -> &mut TiVec<K, V>

Converts this type into a mutable reference of the (usually inferred) input type.

Source §

impl<K, V> AsMut<Vec<V>> for TiVec<K, V>

Source §

fn as_mut(&mut self) -> &mut Vec<V>

Converts this type into a mutable reference of the (usually inferred) input type.

Source §

impl<K, V> AsRef<[V]> for TiVec<K, V>

Source §

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

Converts this type into a shared reference of the (usually inferred) input type.

Source §

impl<K, V> AsRef<TiSlice<K, V>> for TiVec<K, V>

Source §

fn as_ref(&self) -> &TiSlice<K, V>

Converts this type into a shared reference of the (usually inferred) input type.

Source §

impl<K, V> AsRef<TiVec<K, V>> for TiVec<K, V>

Source §

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

Source §

impl<K, V> AsRef<TiVec<K, V>> for Vec<V>

Source §

fn as_ref(&self) -> &TiVec<K, V>

Converts this type into a shared reference of the (usually inferred) input type.

Source §

impl<K, V> AsRef<Vec<V>> for TiVec<K, V>

Source §

fn as_ref(&self) -> &Vec<V>

Converts this type into a shared reference of the (usually inferred) input type.

Source §

impl<K, V> Borrow<TiSlice<K, V>> for TiVec<K, V>

Source §

fn borrow(&self) -> &TiSlice<K, V>

Immutably borrows from an owned value. Read more

Source §

impl<K, V> BorrowMut<TiSlice<K, V>> for TiVec<K, V>

Source §

fn borrow_mut(&mut self) -> &mut TiSlice<K, V>

Mutably borrows from an owned value. Read more

Source §

impl<K, V> Clone for TiVec<K, V>
where V: Clone,

Source §

fn clone(&self) -> Self

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

impl<K, V> Debug for TiVec<K, V>
where K: Debug + From<usize>, V: Debug,

Source §

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

Formats the value using the given formatter. Read more

Source §

impl<K, V> Default for TiVec<K, V>

Source §

fn default() -> Self

Returns the “default value” for a type. Read more

Source §

impl<K, V> Deref for TiVec<K, V>

Source §

type Target = TiSlice<K, V>

The resulting type after dereferencing.

Source §

fn deref(&self) -> &TiSlice<K, V>

Dereferences the value.

Source §

impl<K, V> DerefMut for TiVec<K, V>

Source §

fn deref_mut(&mut self) -> &mut TiSlice<K, V>

Mutably dereferences the value.

Source §

impl<'a, K, V: 'a + Copy> Extend<&'a V> for TiVec<K, V>

Source §

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

Extends a collection with the contents of an iterator. Read more

Source §

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

Source §

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. Read more

Source §

impl<K, V> Extend<V> for TiVec<K, V>

Source §

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

Extends a collection with the contents of an iterator. Read more

Source §

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

Source §

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. Read more

Source §