Skip to content

Commit 686bfc4

Browse files
borsbors
committed
Auto merge of #125010 - matthiaskrgr:rollup-270pck3, r=matthiaskrgr
Rollup of 5 pull requests Successful merges: - #124928 (Stabilize `byte_slice_trim_ascii` for `&[u8]`/`&str`) - #124954 (Document proper usage of `fmt::Error` and `fmt()`'s `Result`.) - #124969 (check if `x test tests` missing any test directory) - #124978 (Handle Deref expressions in invalid_reference_casting) - #125005 (Miri subtree update) r? `@ghost` `@rustbot` modify labels: rollup
2 parents 35c5e67 + 8f03405 commit 686bfc4

File tree

165 files changed

+1267
-1205
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

165 files changed

+1267
-1205
lines changed

‎compiler/rustc_lint/src/reference_casting.rs

+4-2
Original file line numberDiff line numberDiff line change
@@ -202,8 +202,10 @@ fn is_cast_to_bigger_memory_layout<'tcx>(
202202

203203
// if the current expr looks like this `&mut expr[index]` then just looking
204204
// at `expr[index]` won't give us the underlying allocation, so we just skip it
205-
// the same logic applies field access like `&mut expr.field`
206-
if let ExprKind::Index(..) | ExprKind::Field(..) = e_alloc.kind {
205+
// the same logic applies field access `&mut expr.field` and reborrows `&mut *expr`.
206+
if let ExprKind::Index(..) | ExprKind::Field(..) | ExprKind::Unary(UnOp::Deref, ..) =
207+
e_alloc.kind
208+
{
207209
return None;
208210
}
209211

‎library/alloc/src/fmt.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -403,7 +403,7 @@
403403
//! is, a formatting implementation must and may only return an error if the
404404
//! passed-in [`Formatter`] returns an error. This is because, contrary to what
405405
//! the function signature might suggest, string formatting is an infallible
406-
//! operation. This function only returns a result because writing to the
406+
//! operation. This function only returns a [`Result`] because writing to the
407407
//! underlying stream might fail and it must provide a way to propagate the fact
408408
//! that an error has occurred back up the stack.
409409
//!

‎library/core/src/fmt/fmt_trait_method_doc.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Formats the value using the given formatter.
2+
3+
# Errors
4+
5+
This function should return [`Err`] if, and only if, the provided [`Formatter`] returns [`Err`].
6+
String formatting is considered an infallible operation; this function only
7+
returns a [`Result`] because writing to the underlying stream might fail and it must
8+
provide a way to propagate the fact that an error has occurred back up the stack.

‎library/core/src/fmt/mod.rs

+27-15
Original file line numberDiff line numberDiff line change
@@ -72,14 +72,24 @@ pub type Result = result::Result<(), Error>;
7272
/// The error type which is returned from formatting a message into a stream.
7373
///
7474
/// This type does not support transmission of an error other than that an error
75-
/// occurred. Any extra information must be arranged to be transmitted through
76-
/// some other means.
77-
///
78-
/// An important thing to remember is that the type `fmt::Error` should not be
75+
/// occurred. This is because, despite the existence of this error,
76+
/// string formatting is considered an infallible operation.
77+
/// `fmt()` implementors should not return this `Error` unless they received it from their
78+
/// [`Formatter`]. The only time your code should create a new instance of this
79+
/// error is when implementing `fmt::Write`, in order to cancel the formatting operation when
80+
/// writing to the underlying stream fails.
81+
///
82+
/// Any extra information must be arranged to be transmitted through some other means,
83+
/// such as storing it in a field to be consulted after the formatting operation has been
84+
/// cancelled. (For example, this is how [`std::io::Write::write_fmt()`] propagates IO errors
85+
/// during writing.)
86+
///
87+
/// This type, `fmt::Error`, should not be
7988
/// confused with [`std::io::Error`] or [`std::error::Error`], which you may also
8089
/// have in scope.
8190
///
8291
/// [`std::io::Error`]: ../../std/io/struct.Error.html
92+
/// [`std::io::Write::write_fmt()`]: ../../std/io/trait.Write.html#method.write_fmt
8393
/// [`std::error::Error`]: ../../std/error/trait.Error.html
8494
///
8595
/// # Examples
@@ -118,8 +128,10 @@ pub trait Write {
118128
/// This function will return an instance of [`std::fmt::Error`][Error] on error.
119129
///
120130
/// The purpose of that error is to abort the formatting operation when the underlying
121-
/// destination encounters some error preventing it from accepting more text; it should
122-
/// generally be propagated rather than handled, at least when implementing formatting traits.
131+
/// destination encounters some error preventing it from accepting more text;
132+
/// in particular, it does not communicate any information about *what* error occurred.
133+
/// It should generally be propagated rather than handled, at least when implementing
134+
/// formatting traits.
123135
///
124136
/// # Examples
125137
///
@@ -586,7 +598,7 @@ impl Display for Arguments<'_> {
586598
#[rustc_diagnostic_item = "Debug"]
587599
#[rustc_trivial_field_reads]
588600
pub trait Debug {
589-
/// Formats the value using the given formatter.
601+
#[doc = include_str!("fmt_trait_method_doc.md")]
590602
///
591603
/// # Examples
592604
///
@@ -703,7 +715,7 @@ pub use macros::Debug;
703715
#[rustc_diagnostic_item = "Display"]
704716
#[stable(feature = "rust1", since = "1.0.0")]
705717
pub trait Display {
706-
/// Formats the value using the given formatter.
718+
#[doc = include_str!("fmt_trait_method_doc.md")]
707719
///
708720
/// # Examples
709721
///
@@ -777,7 +789,7 @@ pub trait Display {
777789
/// ```
778790
#[stable(feature = "rust1", since = "1.0.0")]
779791
pub trait Octal {
780-
/// Formats the value using the given formatter.
792+
#[doc = include_str!("fmt_trait_method_doc.md")]
781793
#[stable(feature = "rust1", since = "1.0.0")]
782794
fn fmt(&self, f: &mut Formatter<'_>) -> Result;
783795
}
@@ -836,7 +848,7 @@ pub trait Octal {
836848
/// ```
837849
#[stable(feature = "rust1", since = "1.0.0")]
838850
pub trait Binary {
839-
/// Formats the value using the given formatter.
851+
#[doc = include_str!("fmt_trait_method_doc.md")]
840852
#[stable(feature = "rust1", since = "1.0.0")]
841853
fn fmt(&self, f: &mut Formatter<'_>) -> Result;
842854
}
@@ -891,7 +903,7 @@ pub trait Binary {
891903
/// ```
892904
#[stable(feature = "rust1", since = "1.0.0")]
893905
pub trait LowerHex {
894-
/// Formats the value using the given formatter.
906+
#[doc = include_str!("fmt_trait_method_doc.md")]
895907
#[stable(feature = "rust1", since = "1.0.0")]
896908
fn fmt(&self, f: &mut Formatter<'_>) -> Result;
897909
}
@@ -946,7 +958,7 @@ pub trait LowerHex {
946958
/// ```
947959
#[stable(feature = "rust1", since = "1.0.0")]
948960
pub trait UpperHex {
949-
/// Formats the value using the given formatter.
961+
#[doc = include_str!("fmt_trait_method_doc.md")]
950962
#[stable(feature = "rust1", since = "1.0.0")]
951963
fn fmt(&self, f: &mut Formatter<'_>) -> Result;
952964
}
@@ -997,7 +1009,7 @@ pub trait UpperHex {
9971009
#[stable(feature = "rust1", since = "1.0.0")]
9981010
#[rustc_diagnostic_item = "Pointer"]
9991011
pub trait Pointer {
1000-
/// Formats the value using the given formatter.
1012+
#[doc = include_str!("fmt_trait_method_doc.md")]
10011013
#[stable(feature = "rust1", since = "1.0.0")]
10021014
fn fmt(&self, f: &mut Formatter<'_>) -> Result;
10031015
}
@@ -1048,7 +1060,7 @@ pub trait Pointer {
10481060
/// ```
10491061
#[stable(feature = "rust1", since = "1.0.0")]
10501062
pub trait LowerExp {
1051-
/// Formats the value using the given formatter.
1063+
#[doc = include_str!("fmt_trait_method_doc.md")]
10521064
#[stable(feature = "rust1", since = "1.0.0")]
10531065
fn fmt(&self, f: &mut Formatter<'_>) -> Result;
10541066
}
@@ -1099,7 +1111,7 @@ pub trait LowerExp {
10991111
/// ```
11001112
#[stable(feature = "rust1", since = "1.0.0")]
11011113
pub trait UpperExp {
1102-
/// Formats the value using the given formatter.
1114+
#[doc = include_str!("fmt_trait_method_doc.md")]
11031115
#[stable(feature = "rust1", since = "1.0.0")]
11041116
fn fmt(&self, f: &mut Formatter<'_>) -> Result;
11051117
}

‎library/core/src/slice/ascii.rs

+9-12
Original file line numberDiff line numberDiff line change
@@ -114,18 +114,17 @@ impl [u8] {
114114
/// Returns a byte slice with leading ASCII whitespace bytes removed.
115115
///
116116
/// 'Whitespace' refers to the definition used by
117-
/// `u8::is_ascii_whitespace`.
117+
/// [`u8::is_ascii_whitespace`].
118118
///
119119
/// # Examples
120120
///
121121
/// ```
122-
/// #![feature(byte_slice_trim_ascii)]
123-
///
124122
/// assert_eq!(b" \t hello world\n".trim_ascii_start(), b"hello world\n");
125123
/// assert_eq!(b" ".trim_ascii_start(), b"");
126124
/// assert_eq!(b"".trim_ascii_start(), b"");
127125
/// ```
128-
#[unstable(feature = "byte_slice_trim_ascii", issue = "94035")]
126+
#[stable(feature = "byte_slice_trim_ascii", since = "CURRENT_RUSTC_VERSION")]
127+
#[rustc_const_stable(feature = "byte_slice_trim_ascii", since = "CURRENT_RUSTC_VERSION")]
129128
#[inline]
130129
pub const fn trim_ascii_start(&self) -> &[u8] {
131130
let mut bytes = self;
@@ -144,18 +143,17 @@ impl [u8] {
144143
/// Returns a byte slice with trailing ASCII whitespace bytes removed.
145144
///
146145
/// 'Whitespace' refers to the definition used by
147-
/// `u8::is_ascii_whitespace`.
146+
/// [`u8::is_ascii_whitespace`].
148147
///
149148
/// # Examples
150149
///
151150
/// ```
152-
/// #![feature(byte_slice_trim_ascii)]
153-
///
154151
/// assert_eq!(b"\r hello world\n ".trim_ascii_end(), b"\r hello world");
155152
/// assert_eq!(b" ".trim_ascii_end(), b"");
156153
/// assert_eq!(b"".trim_ascii_end(), b"");
157154
/// ```
158-
#[unstable(feature = "byte_slice_trim_ascii", issue = "94035")]
155+
#[stable(feature = "byte_slice_trim_ascii", since = "CURRENT_RUSTC_VERSION")]
156+
#[rustc_const_stable(feature = "byte_slice_trim_ascii", since = "CURRENT_RUSTC_VERSION")]
159157
#[inline]
160158
pub const fn trim_ascii_end(&self) -> &[u8] {
161159
let mut bytes = self;
@@ -175,18 +173,17 @@ impl [u8] {
175173
/// removed.
176174
///
177175
/// 'Whitespace' refers to the definition used by
178-
/// `u8::is_ascii_whitespace`.
176+
/// [`u8::is_ascii_whitespace`].
179177
///
180178
/// # Examples
181179
///
182180
/// ```
183-
/// #![feature(byte_slice_trim_ascii)]
184-
///
185181
/// assert_eq!(b"\r hello world\n ".trim_ascii(), b"hello world");
186182
/// assert_eq!(b" ".trim_ascii(), b"");
187183
/// assert_eq!(b"".trim_ascii(), b"");
188184
/// ```
189-
#[unstable(feature = "byte_slice_trim_ascii", issue = "94035")]
185+
#[stable(feature = "byte_slice_trim_ascii", since = "CURRENT_RUSTC_VERSION")]
186+
#[rustc_const_stable(feature = "byte_slice_trim_ascii", since = "CURRENT_RUSTC_VERSION")]
190187
#[inline]
191188
pub const fn trim_ascii(&self) -> &[u8] {
192189
self.trim_ascii_start().trim_ascii_end()

‎library/core/src/str/mod.rs

+6-9
Original file line numberDiff line numberDiff line change
@@ -2531,15 +2531,14 @@ impl str {
25312531
/// # Examples
25322532
///
25332533
/// ```
2534-
/// #![feature(byte_slice_trim_ascii)]
2535-
///
25362534
/// assert_eq!(" \t \u{3000}hello world\n".trim_ascii_start(), "\u{3000}hello world\n");
25372535
/// assert_eq!(" ".trim_ascii_start(), "");
25382536
/// assert_eq!("".trim_ascii_start(), "");
25392537
/// ```
2540-
#[unstable(feature = "byte_slice_trim_ascii", issue = "94035")]
25412538
#[must_use = "this returns the trimmed string as a new slice, \
25422539
without modifying the original"]
2540+
#[stable(feature = "byte_slice_trim_ascii", since = "CURRENT_RUSTC_VERSION")]
2541+
#[rustc_const_stable(feature = "byte_slice_trim_ascii", since = "CURRENT_RUSTC_VERSION")]
25432542
#[inline]
25442543
pub const fn trim_ascii_start(&self) -> &str {
25452544
// SAFETY: Removing ASCII characters from a `&str` does not invalidate
@@ -2557,15 +2556,14 @@ impl str {
25572556
/// # Examples
25582557
///
25592558
/// ```
2560-
/// #![feature(byte_slice_trim_ascii)]
2561-
///
25622559
/// assert_eq!("\r hello world\u{3000}\n ".trim_ascii_end(), "\r hello world\u{3000}");
25632560
/// assert_eq!(" ".trim_ascii_end(), "");
25642561
/// assert_eq!("".trim_ascii_end(), "");
25652562
/// ```
2566-
#[unstable(feature = "byte_slice_trim_ascii", issue = "94035")]
25672563
#[must_use = "this returns the trimmed string as a new slice, \
25682564
without modifying the original"]
2565+
#[stable(feature = "byte_slice_trim_ascii", since = "CURRENT_RUSTC_VERSION")]
2566+
#[rustc_const_stable(feature = "byte_slice_trim_ascii", since = "CURRENT_RUSTC_VERSION")]
25692567
#[inline]
25702568
pub const fn trim_ascii_end(&self) -> &str {
25712569
// SAFETY: Removing ASCII characters from a `&str` does not invalidate
@@ -2584,15 +2582,14 @@ impl str {
25842582
/// # Examples
25852583
///
25862584
/// ```
2587-
/// #![feature(byte_slice_trim_ascii)]
2588-
///
25892585
/// assert_eq!("\r hello world\n ".trim_ascii(), "hello world");
25902586
/// assert_eq!(" ".trim_ascii(), "");
25912587
/// assert_eq!("".trim_ascii(), "");
25922588
/// ```
2593-
#[unstable(feature = "byte_slice_trim_ascii", issue = "94035")]
25942589
#[must_use = "this returns the trimmed string as a new slice, \
25952590
without modifying the original"]
2591+
#[stable(feature = "byte_slice_trim_ascii", since = "CURRENT_RUSTC_VERSION")]
2592+
#[rustc_const_stable(feature = "byte_slice_trim_ascii", since = "CURRENT_RUSTC_VERSION")]
25962593
#[inline]
25972594
pub const fn trim_ascii(&self) -> &str {
25982595
// SAFETY: Removing ASCII characters from a `&str` does not invalidate

‎src/bootstrap/src/core/builder.rs

+3
Original file line numberDiff line numberDiff line change
@@ -320,11 +320,13 @@ const PATH_REMAP: &[(&str, &[&str])] = &[
320320
(
321321
"tests",
322322
&[
323+
// tidy-alphabetical-start
323324
"tests/assembly",
324325
"tests/codegen",
325326
"tests/codegen-units",
326327
"tests/coverage",
327328
"tests/coverage-run-rustdoc",
329+
"tests/crashes",
328330
"tests/debuginfo",
329331
"tests/incremental",
330332
"tests/mir-opt",
@@ -340,6 +342,7 @@ const PATH_REMAP: &[(&str, &[&str])] = &[
340342
"tests/rustdoc-ui",
341343
"tests/ui",
342344
"tests/ui-fulldeps",
345+
// tidy-alphabetical-end
343346
],
344347
),
345348
];

‎src/bootstrap/src/core/builder/tests.rs

+20
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,26 @@ fn validate_path_remap() {
128128
});
129129
}
130130

131+
#[test]
132+
fn check_missing_paths_for_x_test_tests() {
133+
let build = Build::new(configure("test", &["A-A"], &["A-A"]));
134+
135+
let (_, tests_remap_paths) =
136+
PATH_REMAP.iter().find(|(target_path, _)| *target_path == "tests").unwrap();
137+
138+
let tests_dir = fs::read_dir(build.src.join("tests")).unwrap();
139+
for dir in tests_dir {
140+
let path = dir.unwrap().path();
141+
142+
// Skip if not a test directory.
143+
if path.ends_with("tests/auxiliary") || !path.is_dir() {
144+
continue
145+
}
146+
147+
assert!(tests_remap_paths.iter().any(|item| path.ends_with(*item)), "{} is missing in PATH_REMAP tests list.", path.display());
148+
}
149+
}
150+
131151
#[test]
132152
fn test_exclude() {
133153
let mut config = configure("test", &["A-A"], &["A-A"]);

‎src/tools/miri/.gitignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@ tex/*/out
99
perf.data
1010
perf.data.old
1111
flamegraph.svg
12-
tests/extern-so/libtestlib.so
12+
tests/native-lib/libtestlib.so
1313
.auto-*

0 commit comments

Comments
 (0)