Make Uniform constructors return a result#1229
Merged
Merged
Conversation
This helps tools like `cargo geiger`.
- This is a breaking change. - The new error type had to be made public, otherwise `Uniform` could not be extended for user-defined types by implementing `UniformSampler`. - `rand_distr` was updated accordingly. - Also forbid unsafe code for crates where none is used. Fixes rust-random#1195, rust-random#1211.
dhardy
reviewed
Apr 25, 2022
Member
|
@vks mind if I ping you on the status of this? |
Contributor
Author
|
@dhardy I'll try to have a look this Sunday. |
Member
|
Skimming the above it looks like this should make |
Contributor
Author
|
I have a patch that is almost ready. |
dhardy
approved these changes
Dec 7, 2022
dhardy
left a comment
dhardy
left a comment
Member
There was a problem hiding this comment.
It's worth noting here that this PR introduces .unwrap() in several distributions where it should be statically-verifiable that the range is non-empty, but of course the language doesn't let us do that.
Comment on lines
+265
to
+276
| /// Usually users should not call this directly but prefer to use | ||
| /// [`Uniform::new`]. | ||
| fn new<B1, B2>(low: B1, high: B2) -> Result<Self, Error> | ||
| where | ||
| B1: SampleBorrow<Self::X> + Sized, | ||
| B2: SampleBorrow<Self::X> + Sized; | ||
|
|
||
| /// Construct self, with inclusive bounds `[low, high]`. | ||
| /// | ||
| /// Usually users should not call this directly but instead use | ||
| /// `Uniform::new_inclusive`, which asserts that `low <= high` before | ||
| /// calling this. | ||
| fn new_inclusive<B1, B2>(low: B1, high: B2) -> Self | ||
| /// Usually users should not call this directly but prefer to use | ||
| /// [`Uniform::new_inclusive`]. | ||
| fn new_inclusive<B1, B2>(low: B1, high: B2) -> Result<Self, Error> |
Member
There was a problem hiding this comment.
There's not really a reason users shouldn't call these directly now (IIRC we used to have an assert in Uniform::new), though Uniform::new is probably still the more convenient API.
Member
Contributor
Author
|
I'll try to look into it later this week. |
Member
|
Sure. I used the web interface to make a merge commit, but it may be incorrect. |
dhardy
reviewed
Feb 3, 2023
benjamin-lieser
pushed a commit
to benjamin-lieser/rand
that referenced
this pull request
Feb 5, 2025
* Forbid unsafe code in crates without unsafe code This helps tools like `cargo geiger`. * Make `Uniform` constructors return a result - This is a breaking change. - The new error type had to be made public, otherwise `Uniform` could not be extended for user-defined types by implementing `UniformSampler`. - `rand_distr` was updated accordingly. - Also forbid unsafe code for crates where none is used. Fixes rust-random#1195, rust-random#1211. * Address review feedback * Make `sample_single` return a `Result` * Fix benchmarks * Small fixes * Update src/distributions/uniform.rs
benjamin-lieser
pushed a commit
to benjamin-lieser/rand
that referenced
this pull request
Feb 5, 2025
* Forbid unsafe code in crates without unsafe code This helps tools like `cargo geiger`. * Make `Uniform` constructors return a result - This is a breaking change. - The new error type had to be made public, otherwise `Uniform` could not be extended for user-defined types by implementing `UniformSampler`. - `rand_distr` was updated accordingly. - Also forbid unsafe code for crates where none is used. Fixes rust-random#1195, rust-random#1211. * Address review feedback * Make `sample_single` return a `Result` * Fix benchmarks * Small fixes * Update src/distributions/uniform.rs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Uniformcouldnot be extended for user-defined types by implementing
UniformSampler.rand_distrwas updated accordingly.Fixes #1195, #1211.