mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Rollup merge of #84301 - r00ster91:patch-1, r=kennytm

Browse Source 
Document that `index` and `index_mut` can panic

I thought this was noteworthy and I think a bit more explicitness does no harm.
This commit is contained in:
Mara Bos 2021-04-21 23:06:16 +02:00 committed by GitHub
commit d341851f94
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
library/core/src/ops/index.rs
View File

@ -61,6 +61,10 @@ pub trait Index<Idx: ?Sized> {
type Output: ?Sized; type Output: ?Sized;
/// Performs the indexing (`container[index]`) operation. /// Performs the indexing (`container[index]`) operation.
///
/// # Panics
///
/// May panic if the index is out of bounds.
#[stable(feature = "rust1", since = "1.0.0")] #[stable(feature = "rust1", since = "1.0.0")]
#[track_caller] #[track_caller]
fn index(&self, index: Idx) -> &Self::Output; fn index(&self, index: Idx) -> &Self::Output;
@ -161,6 +165,10 @@ see chapter in The Book <https://doc.rust-lang.org/book/ch08-02-strings.html#ind
#[doc(alias = "[]")] #[doc(alias = "[]")]
pub trait IndexMut<Idx: ?Sized>: Index<Idx> { pub trait IndexMut<Idx: ?Sized>: Index<Idx> {
/// Performs the mutable indexing (`container[index]`) operation. /// Performs the mutable indexing (`container[index]`) operation.
///
/// # Panics
///
/// May panic if the index is out of bounds.
#[stable(feature = "rust1", since = "1.0.0")] #[stable(feature = "rust1", since = "1.0.0")]
#[track_caller] #[track_caller]
fn index_mut(&mut self, index: Idx) -> &mut Self::Output; fn index_mut(&mut self, index: Idx) -> &mut Self::Output;