Ything-RepoMirrors/rust-lang
1
0
Fork 0
mirror of https://github.com/rust-lang/rust.git synced 2026-01-25 07:48:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

Rollup merge of #148662 - leftmostcat:document-isize-limit, r=joboet

Browse Source 
alloc: Document panics when allocations will exceed max

Document panics in `String` and `Vec` due to capacity overflowing `isize::MAX`. Correct outdated claims of `usize::MAX` limit.

Fixes https://github.com/rust-lang/rust/issues/148598.

Ping `@lolbinarycat`
This commit is contained in:
Matthias Krüger
2025-12-05 16:17:05 +01:00
committed by GitHub
parent 97b131c900 5a8cf3362c
commit 4d08c33fc1
2 changed files with 24 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
library/alloc/src/string.rs
View File

@@ -454,6 +454,10 @@ impl String {
///
/// [`new`]: String::new
///
/// # Panics
///
/// Panics if the capacity exceeds `isize::MAX` _bytes_.
///
/// # Examples
///
/// ```
@@ -1079,6 +1083,10 @@ impl String {
/// Appends a given string slice onto the end of this `String`.
///
/// # Panics
///
/// Panics if the new capacity exceeds `isize::MAX` _bytes_.
///
/// # Examples
///
/// ```
@@ -1101,8 +1109,9 @@ impl String {
///
/// # Panics
///
/// Panics if the range has `start_bound > end_bound`, or, if the range is
/// bounded on either end and does not lie on a [`char`] boundary.
/// Panics if the range has `start_bound > end_bound`, if the range is
/// bounded on either end and does not lie on a [`char`] boundary, or if the
/// new capacity exceeds `isize::MAX` bytes.
///
/// # Examples
///
@@ -1158,7 +1167,7 @@ impl String {
///
/// # Panics
///
/// Panics if the new capacity overflows [`usize`].
/// Panics if the new capacity exceeds `isize::MAX` _bytes_.
///
/// # Examples
///
@@ -1208,7 +1217,7 @@ impl String {
///
/// # Panics
///
/// Panics if the new capacity overflows [`usize`].
/// Panics if the new capacity exceeds `isize::MAX` _bytes_.
///
/// # Examples
///
@@ -1372,6 +1381,10 @@ impl String {
/// Appends the given [`char`] to the end of this `String`.
///
/// # Panics
///
/// Panics if the new capacity exceeds `isize::MAX` _bytes_.
///
/// # Examples
///
/// ```

9
library/alloc/src/vec/mod.rs
View File

@@ -3340,6 +3340,10 @@ impl<T: Clone, A: Allocator> Vec<T, A> {
/// except that it also works with slice elements that are Clone but not Copy.
/// If Rust gets specialization this function may be deprecated.
///
/// # Panics
///
/// Panics if the new capacity exceeds `isize::MAX` _bytes_.
///
/// # Examples
///
/// ```
@@ -3361,8 +3365,9 @@ impl<T: Clone, A: Allocator> Vec<T, A> {
///
/// # Panics
///
/// Panics if starting index is greater than the end index
/// or if the index is greater than the length of the vector.
/// Panics if starting index is greater than the end index, if the index is
/// greater than the length of the vector, or if the new capacity exceeds
/// `isize::MAX` _bytes_.
///
/// # Examples
///