1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837
//! `VecMap` is a vector-based map implementation which retains the order inserted entries.
mod entry;
mod impls;
mod iter;
#[cfg(feature = "serde")]
mod serde;
use super::{Entries, Slot};
use alloc::vec::Vec;
use core::borrow::Borrow;
use core::mem;
pub use self::entry::{Entry, OccupiedEntry, VacantEntry};
pub use self::iter::{IntoIter, IntoKeys, IntoValues, Iter, IterMut, Keys, Values, ValuesMut};
/// A vector-based map implementation which retains the order of inserted entries.
///
/// Internally it is represented as a `Vec<(K, V)>` to support keys that are neither `Hash` nor
/// `Ord`.
#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord)]
pub struct VecMap<K, V> {
entries: Vec<Slot<K, V>>,
}
impl<K, V> VecMap<K, V> {
/// Create a new map. (Does not allocate.)
///
/// # Examples
///
/// ```
/// use vecmap::VecMap;
///
/// let mut map: VecMap<i32, &str> = VecMap::new();
/// ```
pub const fn new() -> Self {
VecMap {
entries: Vec::new(),
}
}
/// Create a new map with capacity for `capacity` key-value pairs. (Does not allocate if
/// `capacity` is zero.)
///
/// # Examples
///
/// ```
/// use vecmap::VecMap;
///
/// let mut map: VecMap<i32, &str> = VecMap::with_capacity(10);
/// assert_eq!(map.len(), 0);
/// assert!(map.capacity() >= 10);
/// ```
pub fn with_capacity(capacity: usize) -> Self {
VecMap {
entries: Vec::with_capacity(capacity),
}
}
/// Returns the number of entries the map can hold without reallocating.
///
/// # Examples
///
/// ```
/// use vecmap::VecMap;
///
/// let mut map: VecMap<i32, &str> = VecMap::with_capacity(10);
/// assert_eq!(map.capacity(), 10);
/// ```
pub fn capacity(&self) -> usize {
self.entries.capacity()
}
/// Returns the number of entries in the map, also referred to as its 'length'.
///
/// # Examples
///
/// ```
/// use vecmap::VecMap;
///
/// let mut a = VecMap::new();
/// assert_eq!(a.len(), 0);
/// a.insert(1, "a");
/// assert_eq!(a.len(), 1);
/// ```
pub fn len(&self) -> usize {
self.entries.len()
}
/// Returns `true` if the map contains no entries.
///
/// # Examples
///
/// ```
/// use vecmap::VecMap;
///
/// let mut a = VecMap::new();
/// assert!(a.is_empty());
/// a.insert(1, "a");
/// assert!(!a.is_empty());
/// ```
pub fn is_empty(&self) -> bool {
self.entries.is_empty()
}
/// Clears the map, removing all entries.
///
/// # Examples
///
/// ```
/// use vecmap::VecMap;
///
/// let mut a = VecMap::new();
/// a.insert(1, "a");
/// a.clear();
/// assert!(a.is_empty());
/// ```
pub fn clear(&mut self) {
self.entries.clear();
}
/// Reverses the order of entries in the map, in place.
///
/// # Examples
///
/// ```
/// use vecmap::VecMap;
///
/// let mut map = VecMap::from_iter([("a", 1), ("b", 2), ("c", 3)]);
/// map.reverse();
/// assert_eq!(map, VecMap::from_iter([("c", 3), ("b", 2), ("a", 1)]));
/// ```
pub fn reverse(&mut self) {
self.entries.reverse();
}
/// Reserves capacity for at least `additional` more elements to be inserted in the given
/// `VecMap<K, V>`. The collection may reserve more space to speculatively avoid frequent
/// reallocations. After calling `reserve`, capacity will be greater than or equal to
/// `self.len() + additional`. Does nothing if capacity is already sufficient.
///
/// # Panics
///
/// Panics if the new capacity exceeds `isize::MAX` bytes.
///
/// # Examples
///
/// ```
/// use vecmap::VecMap;
///
/// let mut map = VecMap::from_iter([("a", 1)]);
/// map.reserve(10);
/// assert!(map.capacity() >= 11);
/// ```
pub fn reserve(&mut self, additional: usize) {
self.entries.reserve(additional);
}
}
// Lookup operations.
impl<K, V> VecMap<K, V> {
/// Return `true` if an equivalent to `key` exists in the map.
///
/// # Examples
///
/// ```
/// use vecmap::VecMap;
///
/// let mut map = VecMap::new();
/// map.insert(1, "a");
/// assert_eq!(map.contains_key(&1), true);
/// assert_eq!(map.contains_key(&2), false);
/// ```
pub fn contains_key<Q>(&self, key: &Q) -> bool
where
K: Borrow<Q>,
Q: Eq + ?Sized,
{
self.get_index_of(key).is_some()
}
/// Get the first key-value pair.
///
/// ```
/// use vecmap::VecMap;
///
/// let mut map = VecMap::from_iter([("a", 1), ("b", 2)]);
/// assert_eq!(map.first(), Some((&"a", &1)));
/// ```
pub fn first(&self) -> Option<(&K, &V)> {
self.entries.first().map(Slot::refs)
}
/// Get the first key-value pair, with mutable access to the value.
///
/// # Examples
///
/// ```
/// use vecmap::VecMap;
///
/// let mut map = VecMap::from_iter([("a", 1), ("b", 2)]);
///
/// if let Some((_, v)) = map.first_mut() {
/// *v = *v + 10;
/// }
/// assert_eq!(map.first(), Some((&"a", &11)));
/// ```
pub fn first_mut(&mut self) -> Option<(&K, &mut V)> {
self.entries.first_mut().map(Slot::ref_mut)
}
/// Get the last key-value pair.
///
/// # Examples
///
/// ```
/// use vecmap::VecMap;
///
/// let mut map = VecMap::from_iter([("a", 1), ("b", 2)]);
/// assert_eq!(map.last(), Some((&"b", &2)));
/// map.pop();
/// map.pop();
/// assert_eq!(map.last(), None);
/// ```
pub fn last(&self) -> Option<(&K, &V)> {
self.entries.last().map(Slot::refs)
}
/// Get the last key-value pair, with mutable access to the value.
///
/// # Examples
///
/// ```
/// use vecmap::VecMap;
///
/// let mut map = VecMap::from_iter([("a", 1), ("b", 2)]);
///
/// if let Some((_, v)) = map.last_mut() {
/// *v = *v + 10;
/// }
/// assert_eq!(map.last(), Some((&"b", &12)));
/// ```
pub fn last_mut(&mut self) -> Option<(&K, &mut V)> {
self.entries.last_mut().map(Slot::ref_mut)
}
/// Return a reference to the value stored for `key`, if it is present, else `None`.
///
/// # Examples
///
/// ```
/// use vecmap::VecMap;
///
/// let mut map = VecMap::new();
/// map.insert(1, "a");
/// assert_eq!(map.get(&1), Some(&"a"));
/// assert_eq!(map.get(&2), None);
/// ```
pub fn get<Q>(&self, key: &Q) -> Option<&V>
where
K: Borrow<Q>,
Q: Eq + ?Sized,
{
self.get_slot(key).map(Slot::value_ref)
}
/// Return a mutable reference to the value stored for `key`, if it is present, else `None`.
///
/// # Examples
///
/// ```
/// use vecmap::VecMap;
///
/// let mut map = VecMap::new();
/// map.insert(1, "a");
/// if let Some(x) = map.get_mut(&1) {
/// *x = "b";
/// }
/// assert_eq!(map[&1], "b");
/// ```
pub fn get_mut<Q>(&mut self, key: &Q) -> Option<&mut V>
where
K: Borrow<Q>,
Q: Eq + ?Sized,
{
self.get_slot_mut(key).map(Slot::value_mut)
}
/// Return references to the key-value pair stored at `index`, if it is present, else `None`.
///
/// # Examples
///
/// ```
/// use vecmap::VecMap;
///
/// let mut map = VecMap::new();
/// map.insert(1, "a");
/// assert_eq!(map.get_index(0), Some((&1, &"a")));
/// assert_eq!(map.get_index(1), None);
/// ```
pub fn get_index(&self, index: usize) -> Option<(&K, &V)> {
self.entries.get(index).map(Slot::refs)
}
/// Return a reference to the key and a mutable reference to the value stored at `index`, if it
/// is present, else `None`.
///
/// # Examples
///
/// ```
/// use vecmap::VecMap;
///
/// let mut map = VecMap::new();
/// map.insert(1, "a");
/// if let Some((_, v)) = map.get_index_mut(0) {
/// *v = "b";
/// }
/// assert_eq!(map[0], "b");
/// ```
pub fn get_index_mut(&mut self, index: usize) -> Option<(&K, &mut V)> {
self.entries.get_mut(index).map(Slot::ref_mut)
}
/// Return the index and references to the key-value pair stored for `key`, if it is present,
/// else `None`.
///
/// # Examples
///
/// ```
/// use vecmap::VecMap;
///
/// let mut map = VecMap::new();
/// map.insert(1, "a");
/// assert_eq!(map.get_full(&1), Some((0, &1, &"a")));
/// assert_eq!(map.get_full(&2), None);
/// ```
pub fn get_full<Q>(&self, key: &Q) -> Option<(usize, &K, &V)>
where
K: Borrow<Q>,
Q: Eq + ?Sized,
{
self.get_index_of(key).map(|index| {
let slot = &self.entries[index];
(index, &slot.key, &slot.value)
})
}
/// Return the index, a reference to the key and a mutable reference to the value stored for
/// `key`, if it is present, else `None`.
///
/// # Examples
///
/// ```
/// use vecmap::VecMap;
///
/// let mut map = VecMap::new();
/// map.insert(1, "a");
///
/// if let Some((_, _, v)) = map.get_full_mut(&1) {
/// *v = "b";
/// }
/// assert_eq!(map.get(&1), Some(&"b"));
/// ```
pub fn get_full_mut<Q>(&mut self, key: &Q) -> Option<(usize, &K, &mut V)>
where
K: Borrow<Q>,
Q: Eq + ?Sized,
{
self.get_index_of(key).map(|index| {
let slot = &mut self.entries[index];
(index, &slot.key, &mut slot.value)
})
}
/// Return references to the key-value pair stored for `key`, if it is present, else `None`.
///
/// # Examples
///
/// ```
/// use vecmap::VecMap;
///
/// let mut map = VecMap::new();
/// map.insert(1, "a");
/// assert_eq!(map.get_key_value(&1), Some((&1, &"a")));
/// assert_eq!(map.get_key_value(&2), None);
/// ```
pub fn get_key_value<Q>(&self, key: &Q) -> Option<(&K, &V)>
where
K: Borrow<Q>,
Q: Eq + ?Sized,
{
self.get_slot(key).map(Slot::refs)
}
/// Return item index, if it exists in the map.
///
/// # Examples
///
/// ```
/// use vecmap::VecMap;
///
/// let mut map = VecMap::new();
/// map.insert("a", 10);
/// map.insert("b", 20);
/// assert_eq!(map.get_index_of("a"), Some(0));
/// assert_eq!(map.get_index_of("b"), Some(1));
/// assert_eq!(map.get_index_of("c"), None);
/// ```
pub fn get_index_of<Q>(&self, key: &Q) -> Option<usize>
where
K: Borrow<Q>,
Q: Eq + ?Sized,
{
if self.entries.is_empty() {
return None;
}
self.entries
.iter()
.position(|slot| slot.key.borrow() == key)
}
fn get_slot<Q>(&self, key: &Q) -> Option<&Slot<K, V>>
where
K: Borrow<Q>,
Q: Eq + ?Sized,
{
self.get_index_of(key).map(|index| &self.entries[index])
}
fn get_slot_mut<Q>(&mut self, key: &Q) -> Option<&mut Slot<K, V>>
where
K: Borrow<Q>,
Q: Eq + ?Sized,
{
self.get_index_of(key).map(|index| &mut self.entries[index])
}
}
// Removal operations.
impl<K, V> VecMap<K, V> {
/// Removes the last element from the map and returns it, or [`None`] if it
/// is empty.
///
/// # Examples
///
/// ```
/// use vecmap::VecMap;
///
/// let mut map = VecMap::from_iter([("a", 1), ("b", 2)]);
/// assert_eq!(map.pop(), Some(("b", 2)));
/// assert_eq!(map.pop(), Some(("a", 1)));
/// assert!(map.is_empty());
/// assert_eq!(map.pop(), None);
/// ```
pub fn pop(&mut self) -> Option<(K, V)> {
self.entries.pop().map(Slot::key_value)
}
/// Remove the key-value pair equivalent to `key` and return its value.
///
/// Like `Vec::remove`, the pair is removed by shifting all of the elements that follow it,
/// preserving their relative order. **This perturbs the index of all of those elements!**
///
/// # Examples
///
/// ```
/// use vecmap::VecMap;
///
/// let mut map = VecMap::from_iter([(1, "a"), (2, "b"), (3, "c"), (4, "d")]);
/// assert_eq!(map.remove(&2), Some("b"));
/// assert_eq!(map.remove(&2), None);
/// assert_eq!(map, VecMap::from_iter([(1, "a"), (3, "c"), (4, "d")]));
/// ```
pub fn remove<Q>(&mut self, key: &Q) -> Option<V>
where
K: Borrow<Q>,
Q: Eq + ?Sized,
{
self.get_index_of(key)
.map(|index| self.entries.remove(index))
.map(Slot::value)
}
/// Remove and return the key-value pair equivalent to `key`.
///
/// Like `Vec::remove`, the pair is removed by shifting all of the elements that follow it,
/// preserving their relative order. **This perturbs the index of all of those elements!**
///
/// # Examples
///
/// ```
/// use vecmap::VecMap;
///
/// let mut map = VecMap::from_iter([(1, "a"), (2, "b"), (3, "c"), (4, "d")]);
/// assert_eq!(map.remove_entry(&2), Some((2, "b")));
/// assert_eq!(map.remove_entry(&2), None);
/// assert_eq!(map, VecMap::from_iter([(1, "a"), (3, "c"), (4, "d")]));
/// ```
pub fn remove_entry<Q>(&mut self, key: &Q) -> Option<(K, V)>
where
K: Borrow<Q>,
Q: Eq + ?Sized,
{
self.get_index_of(key)
.map(|index| self.entries.remove(index))
.map(Slot::key_value)
}
/// Remove the key-value pair equivalent to `key` and return its value.
///
/// Like `Vec::swap_remove`, the pair is removed by swapping it with the last element of the
/// map and popping it off. **This perturbs the position of what used to be the last element!**
///
/// Return `None` if `key` is not in map.
///
/// ```
/// use vecmap::VecMap;
///
/// let mut map = VecMap::from_iter([(1, "a"), (2, "b"), (3, "c"), (4, "d")]);
/// assert_eq!(map.swap_remove(&2), Some("b"));
/// assert_eq!(map.swap_remove(&2), None);
/// assert_eq!(map, VecMap::from_iter([(1, "a"), (4, "d"), (3, "c")]));
/// ```
pub fn swap_remove<Q>(&mut self, key: &Q) -> Option<V>
where
K: Borrow<Q>,
Q: Eq + ?Sized,
{
self.get_index_of(key)
.map(|index| self.entries.swap_remove(index))
.map(Slot::value)
}
/// Remove and return the key-value pair equivalent to `key`.
///
/// Like `Vec::swap_remove`, the pair is removed by swapping it with the last element of the
/// map and popping it off. **This perturbs the position of what used to be the last element!**
///
/// Return `None` if `key` is not in map.
///
/// ```
/// use vecmap::VecMap;
///
/// let mut map = VecMap::from_iter([(1, "a"), (2, "b"), (3, "c"), (4, "d")]);
/// assert_eq!(map.swap_remove_entry(&2), Some((2, "b")));
/// assert_eq!(map.swap_remove_entry(&2), None);
/// assert_eq!(map, VecMap::from_iter([(1, "a"), (4, "d"), (3, "c")]));
/// ```
pub fn swap_remove_entry<Q>(&mut self, key: &Q) -> Option<(K, V)>
where
K: Borrow<Q>,
Q: Eq + ?Sized,
{
self.get_index_of(key)
.map(|index| self.entries.swap_remove(index))
.map(Slot::key_value)
}
}
// Insertion operations.
impl<K, V> VecMap<K, V>
where
K: Eq,
{
/// Insert a key-value pair in the map.
///
/// If an equivalent key already exists in the map: the key remains and retains in its place
/// in the order, its corresponding value is updated with `value` and the older value is
/// returned inside `Some(_)`.
///
/// If no equivalent key existed in the map: the new key-value pair is inserted, last in
/// order, and `None` is returned.
///
/// See also [`entry`](#method.entry) if you you want to insert *or* modify or if you need to
/// get the index of the corresponding key-value pair.
///
/// # Examples
///
/// ```
/// use vecmap::VecMap;
///
/// let mut map = VecMap::new();
/// assert_eq!(map.insert(37, "a"), None);
/// assert_eq!(map.is_empty(), false);
///
/// map.insert(37, "b");
/// assert_eq!(map.insert(37, "c"), Some("b"));
/// assert_eq!(map[&37], "c");
/// ```
pub fn insert(&mut self, key: K, value: V) -> Option<V> {
self.insert_full(key, value).1
}
/// Insert a key-value pair in the map, and get their index.
///
/// If an equivalent key already exists in the map: the key remains and
/// retains in its place in the order, its corresponding value is updated
/// with `value` and the older value is returned inside `(index, Some(_))`.
///
/// If no equivalent key existed in the map: the new key-value pair is
/// inserted, last in order, and `(index, None)` is returned.
///
/// Computes in **O(1)** time (amortized average).
///
/// See also [`entry`](#method.entry) if you you want to insert *or* modify
/// or if you need to get the index of the corresponding key-value pair.
///
/// # Examples
///
/// ```
/// use vecmap::VecMap;
///
/// let mut map = VecMap::new();
/// assert_eq!(map.insert_full("a", 1), (0, None));
/// assert_eq!(map.insert_full("b", 2), (1, None));
/// assert_eq!(map.insert_full("b", 3), (1, Some(2)));
/// assert_eq!(map["b"], 3);
/// ```
pub fn insert_full(&mut self, key: K, value: V) -> (usize, Option<V>) {
match self.get_index_of(&key) {
Some(index) => {
let old_slot = mem::replace(&mut self.entries[index], Slot { key, value });
(index, Some(old_slot.value))
}
None => {
let index = self.entries.len();
self.entries.push(Slot { key, value });
(index, None)
}
}
}
/// Get the given key's corresponding entry in the map for insertion and/or in-place
/// manipulation.
///
/// ## Examples
///
/// ```
/// use vecmap::VecMap;
///
/// let mut letters = VecMap::new();
///
/// for ch in "a short treatise on fungi".chars() {
/// letters.entry(ch).and_modify(|counter| *counter += 1).or_insert(1);
/// }
///
/// assert_eq!(letters[&'s'], 2);
/// assert_eq!(letters[&'t'], 3);
/// assert_eq!(letters[&'u'], 1);
/// assert_eq!(letters.get(&'y'), None);
/// ```
pub fn entry(&mut self, key: K) -> Entry<K, V> {
match self.get_index_of(&key) {
Some(index) => Entry::Occupied(OccupiedEntry::new(self, key, index)),
None => Entry::Vacant(VacantEntry::new(self, key)),
}
}
}
// Iterator adapters.
impl<K, V> VecMap<K, V> {
/// An iterator visiting all key-value pairs in insertion order. The iterator element type is
/// `(&'a K, &'a V)`.
///
/// # Examples
///
/// ```
/// use vecmap::VecMap;
///
/// let map = VecMap::from([
/// ("a", 1),
/// ("b", 2),
/// ("c", 3),
/// ]);
///
/// for (key, val) in map.iter() {
/// println!("key: {key} val: {val}");
/// }
/// ```
pub fn iter(&self) -> Iter<'_, K, V> {
Iter::new(self.as_entries())
}
/// An iterator visiting all key-value pairs in insertion order, with mutable references to the
/// values. The iterator element type is `(&'a K, &'a mut V)`.
///
/// # Examples
///
/// ```
/// use vecmap::VecMap;
///
/// let mut map = VecMap::from([
/// ("a", 1),
/// ("b", 2),
/// ("c", 3),
/// ]);
///
/// // Update all values
/// for (_, val) in map.iter_mut() {
/// *val *= 2;
/// }
///
/// for (key, val) in &map {
/// println!("key: {key} val: {val}");
/// }
/// ```
pub fn iter_mut(&mut self) -> IterMut<'_, K, V> {
IterMut::new(self.as_entries_mut())
}
/// An iterator visiting all keys in insertion order. The iterator element type is `&'a K`.
///
/// # Examples
///
/// ```
/// use vecmap::VecMap;
///
/// let map = VecMap::from([
/// ("a", 1),
/// ("b", 2),
/// ("c", 3),
/// ]);
///
/// for key in map.keys() {
/// println!("{key}");
/// }
/// ```
pub fn keys(&self) -> Keys<'_, K, V> {
Keys::new(self.as_entries())
}
/// Creates a consuming iterator visiting all the keys in insertion order. The object cannot be
/// used after calling this. The iterator element type is `K`.
///
/// # Examples
///
/// ```
/// use vecmap::VecMap;
///
/// let map = VecMap::from([
/// ("a", 1),
/// ("b", 2),
/// ("c", 3),
/// ]);
///
/// let mut vec: Vec<&str> = map.into_keys().collect();
/// assert_eq!(vec, ["a", "b", "c"]);
/// ```
pub fn into_keys(self) -> IntoKeys<K, V> {
IntoKeys::new(self.into_entries())
}
/// An iterator visiting all values in insertion order. The iterator element type is `&'a V`.
///
/// # Examples
///
/// ```
/// use vecmap::VecMap;
///
/// let map = VecMap::from([
/// ("a", 1),
/// ("b", 2),
/// ("c", 3),
/// ]);
///
/// for val in map.values() {
/// println!("{val}");
/// }
/// ```
pub fn values(&self) -> Values<'_, K, V> {
Values::new(self.as_entries())
}
/// An iterator visiting all values mutably in insertion order. The iterator element type is
/// `&'a mut V`.
///
/// # Examples
///
/// ```
/// use vecmap::VecMap;
///
/// let mut map = VecMap::from([
/// ("a", 1),
/// ("b", 2),
/// ("c", 3),
/// ]);
///
/// for val in map.values_mut() {
/// *val = *val + 10;
/// }
///
/// for val in map.values() {
/// println!("{val}");
/// }
/// ```
pub fn values_mut(&mut self) -> ValuesMut<'_, K, V> {
ValuesMut::new(self.as_entries_mut())
}
/// Creates a consuming iterator visiting all the values in insertion order. The object cannot
/// be used after calling this. The iterator element type is `V`.
///
/// # Examples
///
/// ```
/// use vecmap::VecMap;
///
/// let map = VecMap::from([
/// ("a", 1),
/// ("b", 2),
/// ("c", 3),
/// ]);
///
/// let mut vec: Vec<i32> = map.into_values().collect();
/// assert_eq!(vec, [1, 2, 3]);
/// ```
pub fn into_values(self) -> IntoValues<K, V> {
IntoValues::new(self.into_entries())
}
}
impl<K, V> Entries for VecMap<K, V> {
type Entry = Slot<K, V>;
fn as_entries(&self) -> &[Self::Entry] {
&self.entries
}
fn as_entries_mut(&mut self) -> &mut [Self::Entry] {
&mut self.entries
}
fn into_entries(self) -> Vec<Self::Entry> {
self.entries
}
}