Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

improve panic message for slice windows and chunks #107442

Merged
merged 1 commit into from
Feb 1, 2023

Conversation

lukas-code
Copy link
Member

@lukas-code lukas-code commented Jan 29, 2023

before:

thread 'main' panicked at 'size is zero', /rustc/1e225413a21fa69570bd3fefea9eb05e33f8b917/library/core/src/slice/mod.rs:809:44
thread 'main' panicked at 'assertion failed: `(left != right)`
  left: `0`,
 right: `0`: chunks cannot have a size of zero', /rustc/1e225413a21fa69570bd3fefea9eb05e33f8b917/library/core/src/slice/mod.rs:843:9

after:

thread 'main' panicked at 'chunk size must be non-zero', src/main.rs:4:22

fixes #107437

@rustbot
Copy link
Collaborator

rustbot commented Jan 29, 2023

r? @cuviper

(rustbot has picked a reviewer for you, use r? to override)

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-libs Relevant to the library team, which will review and decide on the PR/issue. labels Jan 29, 2023
@rustbot
Copy link
Collaborator

rustbot commented Jan 29, 2023

Hey! It looks like you've submitted a new PR for the library teams!

If this PR contains changes to any rust-lang/rust public library APIs then please comment with @rustbot label +T-libs-api -T-libs to tag it appropriately. If this PR contains changes to any unstable APIs please edit the PR description to add a link to the relevant API Change Proposal or create one if you haven't already. If you're unsure where your change falls no worries, just leave it as is and the reviewer will take a look and make a decision to forward on if necessary.

Examples of T-libs-api changes:

  • Stabilizing library features
  • Introducing insta-stable changes such as new implementations of existing stable traits on existing stable types
  • Introducing new or changing existing unstable library APIs (excluding permanently unstable features / features without a tracking issue)
  • Changing public documentation in ways that create new stability guarantees
  • Changing observable runtime behavior of library APIs

library/core/src/slice/mod.rs Outdated Show resolved Hide resolved
@albertlarsan68
Copy link
Member

Bringing my 2 cents:
I think it should be a diagnostic rather than a panic, but I don't know whether this is feasible.

@eggyal
Copy link
Contributor

eggyal commented Jan 29, 2023

@albertlarsan68: there are unstable/nightly-only APIs like array_windows that can be enforced at compile-time, but for windows etc the window-size is not known until runtime.

@lukas-code
Copy link
Member Author

like array_windows that can be enforced at compile-time

That's #99471.

diagnostic

It's probably possible to create a lint similar to unconditional_panic, but that's out of scope for this PR.

@eggyal
Copy link
Contributor

eggyal commented Jan 29, 2023

It's probably possible to create a lint similar to unconditional_panic

Sure, but only for situations where the runtime size can be const-folded and evaluated to be 0 at compile-time.

@cuviper
Copy link
Member

cuviper commented Jan 30, 2023

I think ArrayChunks::new's direct style is better, and a strong "must" is appropriate:

assert!(N != 0, "chunk size must be non-zero");

It's also clear to say just "chunk size" or "window size", rather than mixing up windows/chunks/rchunks variants.

@lukas-code
Copy link
Member Author

I've updated the wording to "chunk size must be non-zero" everywhere and use assert! instead of assert_ne! to remove the redundant 0 != 0.

Copy link
Member

@cuviper cuviper left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Windows are different than chunks. :)

library/core/src/slice/mod.rs Outdated Show resolved Hide resolved
library/core/src/slice/mod.rs Outdated Show resolved Hide resolved
@lukas-code
Copy link
Member Author

Sorry, I thought that was what you meant by #107442 (comment). I changed window back now.

@cuviper
Copy link
Member

cuviper commented Jan 31, 2023

Ah, I only meant that "window/chunk size" should be the subject, rather than "windows/chunks" (the methods) as the subject having a size. Anyway, looks good now!

@bors r+

@bors
Copy link
Contributor

bors commented Jan 31, 2023

📌 Commit 2fbe927 has been approved by cuviper

It is now in the queue for this repository.

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jan 31, 2023
bors added a commit to rust-lang-ci/rust that referenced this pull request Feb 1, 2023
…iaskrgr

Rollup of 6 pull requests

Successful merges:

 - rust-lang#107389 (Fixing confusion between mod and remainder)
 - rust-lang#107442 (improve panic message for slice windows and chunks)
 - rust-lang#107470 (Small bootstrap improvements)
 - rust-lang#107487 (Make the "extra if in let...else block" hint a suggestion)
 - rust-lang#107499 (Do not depend on Generator trait when deducing closure signature)
 - rust-lang#107533 (Extend `-Z print-type-sizes` to distinguish generator upvars+locals from "normal" fields.)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 1dbb5ef into rust-lang:master Feb 1, 2023
@rustbot rustbot added this to the 1.69.0 milestone Feb 1, 2023
@lukas-code lukas-code deleted the slice-panics branch February 1, 2023 11:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-libs Relevant to the library team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Ambiguous error for slice.windows()
6 participants