nordic-dev.net/rust
nordic-dev.net/rust
2
0
Fork 0
mirror of https://github.com/rust-lang/rust.git synced 2024-11-25 16:24:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

Rollup merge of #119800 - dev-ardi:tmp, r=wesleywiser

Browse Source 
Document `rustc_index::vec::IndexVec`

Document a few of the methods.

Part of https://github.com/rust-lang/rust/issues/93792.
This commit is contained in:
Matthias Krüger 2024-01-26 23:15:50 +01:00 committed by GitHub
commit b31bf24908
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
compiler/rustc_index/src/vec.rs
View File

@ -12,10 +12,13 @@ use std::vec;
use crate::{Idx, IndexSlice}; use crate::{Idx, IndexSlice};
/// An owned contiguous collection of `T`s, indexed by `I` rather than by `usize`. /// An owned contiguous collection of `T`s, indexed by `I` rather than by `usize`.
/// Its purpose is to avoid mixing indexes.
/// ///
/// While it's possible to use `u32` or `usize` directly for `I`, /// While it's possible to use `u32` or `usize` directly for `I`,
/// you almost certainly want to use a [`newtype_index!`]-generated type instead. /// you almost certainly want to use a [`newtype_index!`]-generated type instead.
/// ///
/// This allows to index the IndexVec with the new index type.
///
/// [`newtype_index!`]: ../macro.newtype_index.html /// [`newtype_index!`]: ../macro.newtype_index.html
#[derive(Clone, PartialEq, Eq, Hash)] #[derive(Clone, PartialEq, Eq, Hash)]
#[repr(transparent)] #[repr(transparent)]
@ -25,11 +28,13 @@ pub struct IndexVec<I: Idx, T> {
} }
impl<I: Idx, T> IndexVec<I, T> { impl<I: Idx, T> IndexVec<I, T> {
/// Constructs a new, empty `IndexVec<I, T>`.
#[inline] #[inline]
pub const fn new() -> Self { pub const fn new() -> Self {
IndexVec::from_raw(Vec::new()) IndexVec::from_raw(Vec::new())
} }
/// Constructs a new `IndexVec<I, T>` from a `Vec<T>`.
#[inline] #[inline]
pub const fn from_raw(raw: Vec<T>) -> Self { pub const fn from_raw(raw: Vec<T>) -> Self {
IndexVec { raw, _marker: PhantomData } IndexVec { raw, _marker: PhantomData }
@ -59,6 +64,7 @@ impl<I: Idx, T> IndexVec<I, T> {
IndexVec::from_raw(vec![elem; universe.len()]) IndexVec::from_raw(vec![elem; universe.len()])
} }
/// Creates a new IndexVec with n copies of the `elem`.
#[inline] #[inline]
pub fn from_elem_n(elem: T, n: usize) -> Self pub fn from_elem_n(elem: T, n: usize) -> Self
where where
@ -85,6 +91,7 @@ impl<I: Idx, T> IndexVec<I, T> {
IndexSlice::from_raw_mut(&mut self.raw) IndexSlice::from_raw_mut(&mut self.raw)
} }
/// Pushes an element to the array returning the index where it was pushed to.
#[inline] #[inline]
pub fn push(&mut self, d: T) -> I { pub fn push(&mut self, d: T) -> I {
let idx = self.next_index(); let idx = self.next_index();