Implement `ByteStr` and `ByteString` types #135073

joshtriplett · 2025-01-03T14:20:25Z

Approved ACP: rust-lang/libs-team#502
Tracking issue: #134915

These types represent human-readable strings that are conventionally,
but not always, UTF-8. The Debug impl prints non-UTF-8 bytes using
escape sequences, and the Display impl uses the Unicode replacement
character.

This is a minimal implementation of these types and associated trait
impls. It does not add any helper methods to other types such as [u8]
or Vec<u8>.

I've omitted a few implementations of AsRef, AsMut, and Borrow,
when those would be the second implementation for a type (counting the
T impl), to avoid potential inference failures. We can attempt to add
more impls later in standalone commits, and run them through crater.

In addition to the bstr feature, I've added a bstr_internals feature
for APIs provided by core for use by alloc but not currently
intended for stabilization.

This API and its implementation are based heavily on the bstr crate
by Andrew Gallant (@BurntSushi).

r? @BurntSushi

tests/ui/array-slice-vec/slice-to-vec-comparison.stderr

craterbot · 2025-01-07T20:13:24Z

🚧 Experiment pr-135073-1 is now running

ℹ️ Crater is a tool to run experiments across parts of the Rust ecosystem. Learn more

craterbot · 2025-01-07T22:06:22Z

🎉 Experiment pr-135073-1 is completed!
📊 106 regressed and 0 fixed (2028 total)
📰 Open the full report.

⚠️ If you notice any spurious failure please add them to the denylist!
ℹ️ Crater is a tool to run experiments across parts of the Rust ecosystem. Learn more

@BurntSushi

Approved ACP: rust-lang/libs-team#502 Tracking issue: rust-lang#134915 These types represent human-readable strings that are conventionally, but not always, UTF-8. The `Debug` impl prints non-UTF-8 bytes using escape sequences, and the `Display` impl uses the Unicode replacement character. This is a minimal implementation of these types and associated trait impls. It does not add any helper methods to other types such as `[u8]` or `Vec<u8>`. I've omitted a few implementations of `AsRef`, `AsMut`, `Borrow`, `From`, and `PartialOrd`, when those would be the second implementation for a type (counting the `T` impl) or otherwise may cause inference failures. These impls are important, but we can attempt to add them later in standalone commits, and run them through crater. In addition to the `bstr` feature, I've added a `bstr_internals` feature for APIs provided by `core` for use by `alloc` but not currently intended for stabilization. This API and its implementation are based *heavily* on the `bstr` crate by Andrew Gallant (@BurntSushi).

The Deref brings in the documentation from slice, so it has the same issue as slice.

For now, apply `no_global_oom_handling` to all of library/alloc/src/bstr.rs . We can make it more fine-grained later.

joshtriplett · 2025-01-12T07:46:38Z

@bors try

bors · 2025-01-12T07:47:49Z

⌛ Trying commit 76780fa with merge cd474b1...

Implement `ByteStr` and `ByteString` types Approved ACP: rust-lang/libs-team#502 Tracking issue: rust-lang#134915 These types represent human-readable strings that are conventionally, but not always, UTF-8. The `Debug` impl prints non-UTF-8 bytes using escape sequences, and the `Display` impl uses the Unicode replacement character. This is a minimal implementation of these types and associated trait impls. It does not add any helper methods to other types such as `[u8]` or `Vec<u8>`. I've omitted a few implementations of `AsRef`, `AsMut`, and `Borrow`, when those would be the second implementation for a type (counting the `T` impl), to avoid potential inference failures. We can attempt to add more impls later in standalone commits, and run them through crater. In addition to the `bstr` feature, I've added a `bstr_internals` feature for APIs provided by `core` for use by `alloc` but not currently intended for stabilization. This API and its implementation are based *heavily* on the `bstr` crate by Andrew Gallant (`@BurntSushi).` r? `@BurntSushi`

bors · 2025-01-12T09:34:54Z

☀️ Try build successful - checks-actions
Build commit: cd474b1 (cd474b13e69f2f8e9a16c20b9cc28edd1f4110e7)

joshtriplett · 2025-01-12T10:27:07Z

Some analysis on some of the remaining crater items:

Note that some of these manifest as an error about Borrow or AsRef, but they're actually about From impls.

Under build failed (unknown):

Several old git repos use an old git commit version of MoonZoon that has unnecessary .into() calls; the current version no longer seems to have those.
argparse-rs (used by a couple of crates) contains unnecessary .into() calls. This is a ten-year-old argument parsing crate that unconditionally prints its arguments when run. I don't think it's a blocker.
One project uses an old non-upstream git branch of yew that has unnecessary .into() calls. This doesn't appear to be an issue in any released version.
A couple of crates use rust_json, which has unnecessary .into() calls; this is already fixed in the current git version and I've requested a publish of that version.
One project uses an old version of a crate bevy_gltf_components from Blenvy which has unnecessary .into() calls. The current version has fixed this.
One project uses boilerpipe, which has one unnecessary .into() call. I've submitted a PR to fix this.

Under build compiler-error(E0283):

index_alloc has a function with a very broad signature that accepts any impl of From, and code using it can break with the introduction of any new impl of From. I've reported this.
PyPirv has an unnecessary .into() call; I've submitted a PR for this.

I'm going to go ahead and remove some more From impls for now, even though those impls are going to be annoying to do without.

joshtriplett · 2025-01-12T10:54:15Z

@bors try

Implement `ByteStr` and `ByteString` types Approved ACP: rust-lang/libs-team#502 Tracking issue: rust-lang#134915 These types represent human-readable strings that are conventionally, but not always, UTF-8. The `Debug` impl prints non-UTF-8 bytes using escape sequences, and the `Display` impl uses the Unicode replacement character. This is a minimal implementation of these types and associated trait impls. It does not add any helper methods to other types such as `[u8]` or `Vec<u8>`. I've omitted a few implementations of `AsRef`, `AsMut`, and `Borrow`, when those would be the second implementation for a type (counting the `T` impl), to avoid potential inference failures. We can attempt to add more impls later in standalone commits, and run them through crater. In addition to the `bstr` feature, I've added a `bstr_internals` feature for APIs provided by `core` for use by `alloc` but not currently intended for stabilization. This API and its implementation are based *heavily* on the `bstr` crate by Andrew Gallant (`@BurntSushi).` r? `@BurntSushi`

bors · 2025-01-12T10:55:25Z

⌛ Trying commit 22a4ec3 with merge 94d9044...

bors · 2025-01-12T12:43:14Z

☀️ Try build successful - checks-actions
Build commit: 94d9044 (94d9044c53e7ebf518ede2bec35f06c51ca83f62)

joshtriplett · 2025-01-12T14:23:31Z

@craterbot check crates=https://crater-reports.s3.amazonaws.com/pr-135073-1/retry-regressed-list.txt

craterbot · 2025-01-12T14:23:36Z

👌 Experiment pr-135073-2 created and queued.
🤖 Automatically detected try build 94d9044
🔍 You can check out the queue and this experiment's details.

ℹ️ Crater is a tool to run experiments across parts of the Rust ecosystem. Learn more

craterbot · 2025-01-13T03:20:51Z

🚧 Experiment pr-135073-2 is now running

ℹ️ Crater is a tool to run experiments across parts of the Rust ecosystem. Learn more

craterbot · 2025-01-13T05:04:56Z

🎉 Experiment pr-135073-2 is completed!
📊 0 regressed and 0 fixed (167 total)
📰 Open the full report.

⚠️ If you notice any spurious failure please add them to the denylist!
ℹ️ Crater is a tool to run experiments across parts of the Rust ecosystem. Learn more

joshtriplett · 2025-01-13T05:51:00Z

Well, that's definitive.

This is ready for review.

joshtriplett added the T-libs-api Relevant to the library API team, which will review and decide on the PR/issue. label Jan 3, 2025

rustbot assigned BurntSushi Jan 3, 2025

rustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jan 3, 2025

joshtriplett force-pushed the bstr branch from 87bb396 to 27449f0 Compare January 3, 2025 15:55