pub struct Stash<V, Ix = usize> { /* private fields */ }
Expand description
An O(1)
amortized table that reuses keys.
Guarantees and non-guarantees:
Stash
is deterministic and keys do not depend on the inserted values. This means you can update two stashes in tandem and get the same keys back. This could be useful for, e.g., primary/secondary replication.- Keys will always be less than the maximum number of items that have ever
been present in the
Stash
at any single point in time. In other words, if you never store more thann
items in aStash
, the stash will only assign keys less thann
. You can take advantage of this guarantee to truncate the key from ausize
to some smaller type. - Except the guarantees noted above, you can assume nothing about key assignment or iteration order. They can change at any time.
An example use case is a file descriptor table.
Implementations§
source§impl<V> Stash<V, usize>
impl<V> Stash<V, usize>
sourcepub const fn new() -> Self
pub const fn new() -> Self
Constructs a new, empty Stash<V, usize>
.
This is a convenience method. Use Stash::default
for
a constructor that is generic in the type of index used.
The stash will not allocate until elements are put onto it.
Examples
use stash::Stash;
let mut stash: Stash<i32> = Stash::new();
sourcepub fn with_capacity(capacity: usize) -> Self
pub fn with_capacity(capacity: usize) -> Self
Constructs a new, empty Stash<V, usize>
with the specified capacity.
This is a convenience method. Use Stash::default
for
a constructor that is generic in the type of index used. In that case
you can call reserve
on the newly created stash to specify the
capacity you need.
The stash will be able to hold exactly capacity
elements without
reallocating. If capacity
is 0, the stash will not allocate.
It is important to note that this function does not specify the length
of the returned stash , but only the capacity. (For an explanation of
the difference between length and capacity, see the main Vec<T>
docs
in the std::vec
module, ‘Capacity and reallocation’.)
Examples
use stash::Stash;
let mut stash = Stash::with_capacity(10);
// The stash contains no items, even though it has capacity for more
assert_eq!(stash.len(), 0);
// These are all done without reallocating...
for i in 0i32..10 {
let _ = stash.put(i);
}
// ...but this may make the stash reallocate
stash.put(11);
source§impl<V, Ix> Stash<V, Ix>where
Ix: Index,
impl<V, Ix> Stash<V, Ix>where Ix: Index,
sourcepub fn capacity(&self) -> usize
pub fn capacity(&self) -> usize
Returns the number of elements the stash can hold without reallocating.
Examples
use stash::Stash;
let stash: Stash<i32> = Stash::with_capacity(10);
assert_eq!(stash.capacity(), 10);
sourcepub fn len(&self) -> usize
pub fn len(&self) -> usize
The number of items in the stash.
Examples
use stash::Stash;
let mut stash = Stash::new();
assert_eq!(stash.len(), 0);
stash.put("a");
assert_eq!(stash.len(), 1);
sourcepub fn reserve(&mut self, additional: usize)
pub fn reserve(&mut self, additional: usize)
Reserves capacity for at least additional
more elements to be put into
the given Stash<T>
. The collection may reserve more space to avoid
frequent reallocations.
Panics
Panics if the new capacity overflows usize
.
Examples
use stash::Stash;
let mut stash: Stash<i32> = Stash::new();
let t1 = stash.put(1);
stash.reserve(10);
assert!(stash.capacity() >= 11);
sourcepub fn reserve_exact(&mut self, additional: usize)
pub fn reserve_exact(&mut self, additional: usize)
Reserves the minimum capacity for exactly additional
more elements to
be put into the given Stash<T>
. Does nothing if the capacity is already
sufficient.
Note that the allocator may give the collection more space than it requests. Therefore
capacity can not be relied upon to be precisely minimal. Prefer reserve
if future
puts are expected.
Panics
Panics if the new capacity overflows usize
.
Examples
use stash::Stash;
let mut stash: Stash<i32> = Stash::new();
let t1 = stash.put(1);
stash.reserve_exact(10);
assert!(stash.capacity() >= 11);
sourcepub fn next_index(&self) -> Ix
pub fn next_index(&self) -> Ix
Get the index that would be returned from next call to put
.
Panics
Panics if the size of the Stash<V, Ix>
would overflow the Ix
index type.
sourcepub fn put(&mut self, value: V) -> Ix
pub fn put(&mut self, value: V) -> Ix
Put a value into the stash.
Returns the index at which this value was stored.
Panics
Panics if the size of the Stash<V, Ix>
would overflow the Ix
index type.
sourcepub fn extend<I>(&mut self, iter: I) -> Extend<'_, I, Ix> ⓘwhere
I: Iterator<Item = V>,
pub fn extend<I>(&mut self, iter: I) -> Extend<'_, I, Ix> ⓘwhere I: Iterator<Item = V>,
Put all items in the iterator into the stash.
Returns an iterator over the indices where the items were inserted. The items are actually inserted as the Iterator is read. If the returned Iterator is dropped, the rest of the items will be inserted all at once.
sourcepub fn iter(&self) -> Iter<'_, V, Ix> ⓘ
pub fn iter(&self) -> Iter<'_, V, Ix> ⓘ
Iterate over the items in this Stash<V>
.
Returns an iterator that yields (index, &value)
pairs.
sourcepub fn iter_mut(&mut self) -> IterMut<'_, V, Ix> ⓘ
pub fn iter_mut(&mut self) -> IterMut<'_, V, Ix> ⓘ
Mutably iterate over the items in this Stash<V>
.
Returns an iterator that yields (index, &mut value)
pairs.
sourcepub fn values_mut(&mut self) -> ValuesMut<'_, V> ⓘ
pub fn values_mut(&mut self) -> ValuesMut<'_, V> ⓘ
Mutably iterate over the values in this Stash<V>
by reference.
sourcepub fn into_values(self) -> IntoValues<V> ⓘ
pub fn into_values(self) -> IntoValues<V> ⓘ
Iterate over the values in this Stash<V>
by value.
sourcepub fn is_empty(&self) -> bool
pub fn is_empty(&self) -> bool
Check if this Stash<V>
is empty.
Returns true
if this Stash<V>
is empty.
sourcepub unsafe fn take_unchecked(&mut self, index: Ix) -> V
pub unsafe fn take_unchecked(&mut self, index: Ix) -> V
Take an item from a slot (if non empty) without bounds or empty checking. So use it very carefully!
Safety
This can be safely used as long as the user does not mutate
indices
from put
and is sure not to have taken the value
associated with the given index
.
sourcepub unsafe fn get_unchecked(&self, index: Ix) -> &V
pub unsafe fn get_unchecked(&self, index: Ix) -> &V
Get a reference to the value at index
without bounds or empty checking.
So use it very carefully!
Safety
This can be safely used as long as the user does not mutate
indices
from put
and is sure not to have taken the value
associated with the given index
.
sourcepub fn get_mut(&mut self, index: Ix) -> Option<&mut V>
pub fn get_mut(&mut self, index: Ix) -> Option<&mut V>
Get a mutable reference to the value at index
.
sourcepub unsafe fn get_unchecked_mut(&mut self, index: Ix) -> &mut V
pub unsafe fn get_unchecked_mut(&mut self, index: Ix) -> &mut V
Get a mutable reference to the value at index
without bounds or empty checking.
So use it very carefully!
Safety
This can be safely used as long as the user does not mutate
indices
from put
and is sure not to have taken the value
associated with the given index
.