bjoernager/rust
bjoernager/rust
1
Fork 0
Code Issues Pull requests Activity

Edit rustc_index::vec::IndexVec::pick3_mut docs

Browse source 
Clarify when this method will panic.

Also fix formatting for `pick2_mut`.
This commit is contained in:
pierwill 2022-07-21 08:49:53 -05:00 • committed by pierwill
parent 74f600b990
commit aad1aa3408
1 changed files with 6 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

8
compiler/rustc_index/src/vec.rs
View file

@ -234,7 +234,9 @@ impl<I: Idx, T> IndexVec<I, T> {
self.raw.get_mut(index.index())
}
/// Returns mutable references to two distinct elements, a and b. Panics if a == b.
/// Returns mutable references to two distinct elements, `a` and `b`.
///
/// Panics if `a == b`.
#[inline]
pub fn pick2_mut(&mut self, a: I, b: I) -> (&mut T, &mut T) {
let (ai, bi) = (a.index(), b.index());
@ -249,7 +251,9 @@ impl<I: Idx, T> IndexVec<I, T> {
}
}
/// Returns mutable references to three distinct elements or panics otherwise.
/// Returns mutable references to three distinct elements.
///
/// Panics if the elements are not distinct.
#[inline]
pub fn pick3_mut(&mut self, a: I, b: I, c: I) -> (&mut T, &mut T, &mut T) {
let (ai, bi, ci) = (a.index(), b.index(), c.index());