Tweak `Error` representation by newpavlov · Pull Request #614 · rust-random/getrandom

newpavlov · 2025-03-03T13:33:55Z

On UEFI targets Error is now represented as NonZeroUsize and on other targets as NonZeroI32. In the former case OS errors have the highest bit set to 1, while in the latter case OS errors are represented as negative integers.

Additionally, this PR removes Error::INTERNAL_START and Error::CUSTOM_START associated constants since the constants are no longer relevant and the inner representation is an internal detail. This is technically a breaking change, but I highly doubt that downstream users rely on them since they can not be used for anything useful, so we can consider it as a "fix" of unintentionally exported constants.

Closes#568

newpavlov · 2025-03-03T16:30:51Z

@josephlr
Note that I plan to release v0.3.2. after merging this (with a separate release PR), so if you have any objections or suggestions about the recently merged PR it's worth to sort them out before that.

josephlr · 2025-03-04T10:54:25Z

@josephlr Note that I plan to release v0.3.2. after merging this (with a separate release PR), so if you have any objections or suggestions about the recently merged PR it's worth to sort them out before that.

That sounds like a good plan, I'm currently working through some of the recently merged PRs. I should hopefully be done by tomorrow. Thanks for all the fixes and reviews. Sorry I haven't had a huge amount of time for this recently.

josephlr

I like this change, i have some suggestions on how we might make this easier to follow

josephlr · 2025-03-05T12:36:45Z

@josephlr Note that I plan to release v0.3.2. after merging this (with a separate release PR), so if you have any objections or suggestions about the recently merged PR it's worth to sort them out before that.
That sounds like a good plan, I'm currently working through some of the recently merged PRs. I should hopefully be done by tomorrow. Thanks for all the fixes and reviews. Sorry I haven't had a huge amount of time for this recently.

I didn't quite get to all of the PRs today, but a quick skim shows nothing glaringly bad. I have a few ideas for PRs that might clean things up, but nothing that should block release.

josephlr

Looks good to me, do we want to make the changes to efi_rng.rs in this PR, or in a followup PR.

…rom_uefi_code`

newpavlov · 2025-03-07T09:34:14Z

do we want to make the changes to efi_rng.rs in this PR

I added commits which change efi_rng appropriately (I thought I already did it, but I guess it has slipped my mind for some reason).

### Added - `efi_rng` opt-in backend [#570] - `linux_raw` opt-in backend [#572] - `.cargo/config.toml` example in the crate-level docs [#591] - `getrandom_test_linux_without_fallback` configuration flag to test that file fallback is not triggered in the `linux_android_with_fallback` backend [#605] - Built-in support for `*-linux-none` targets [#618] - Cygwin support [#626] ### Changed - Update `wasi` dependency to v0.14 [#594] - Add `#[inline]` attribute to the inner functions [#596] - Update WASI and Emscripten links in the crate-level docs [#597] - Do not use `dlsym` on MUSL targets in the `linux_android_with_fallback` backend [#602] - Remove `linux_android.rs` and use `getrandom.rs` instead [#603] - Always use `RtlGenRandom` on Windows targets when compiling with pre-1.78 Rust [#610] - Internal representation of the `Error` type [#614] - Remove `windows-targets` dependency and use [`raw-dylib`] directly [#627] ### Removed - `Error::INTERNAL_START` and `Error::CUSTOM_START` associated constants [#614] [#570]: #570 [#572]: #572 [#591]: #591 [#594]: #594 [#596]: #596 [#597]: #597 [#602]: #602 [#603]: #603 [#605]: #605 [#610]: #610 [#614]: #614 [#618]: #618 [#626]: #626 [#627]: #627 [`raw-dylib`]: https://doc.rust-lang.org/reference/items/external-blocks.html?highlight=link#dylib-versus-raw-dylib

On UEFI targets `Error` is now represented as `NonZeroUsize` and on other targets as `NonZeroI32`. In the former case OS errors have the highest bit set to 1, while in the latter case OS errors are represented as negative integers. Additionally, this PR removes `Error::INTERNAL_START` and `Error::CUSTOM_START` associated constants since the constants are no longer relevant and the inner representation is an internal detail. This is technically a breaking change, but I highly doubt that downstream users rely on them since they can not be used for anything useful, so we can consider it as a "fix" of unintentionally exported constants.

### Added - `efi_rng` opt-in backend [rust-random#570] - `linux_raw` opt-in backend [rust-random#572] - `.cargo/config.toml` example in the crate-level docs [rust-random#591] - `getrandom_test_linux_without_fallback` configuration flag to test that file fallback is not triggered in the `linux_android_with_fallback` backend [rust-random#605] - Built-in support for `*-linux-none` targets [rust-random#618] - Cygwin support [rust-random#626] ### Changed - Update `wasi` dependency to v0.14 [rust-random#594] - Add `#[inline]` attribute to the inner functions [rust-random#596] - Update WASI and Emscripten links in the crate-level docs [rust-random#597] - Do not use `dlsym` on MUSL targets in the `linux_android_with_fallback` backend [rust-random#602] - Remove `linux_android.rs` and use `getrandom.rs` instead [rust-random#603] - Always use `RtlGenRandom` on Windows targets when compiling with pre-1.78 Rust [rust-random#610] - Internal representation of the `Error` type [rust-random#614] - Remove `windows-targets` dependency and use [`raw-dylib`] directly [rust-random#627] ### Removed - `Error::INTERNAL_START` and `Error::CUSTOM_START` associated constants [rust-random#614] [rust-random#570]: rust-random#570 [rust-random#572]: rust-random#572 [rust-random#591]: rust-random#591 [rust-random#594]: rust-random#594 [rust-random#596]: rust-random#596 [rust-random#597]: rust-random#597 [rust-random#602]: rust-random#602 [rust-random#603]: rust-random#603 [rust-random#605]: rust-random#605 [rust-random#610]: rust-random#610 [rust-random#614]: rust-random#614 [rust-random#618]: rust-random#618 [rust-random#626]: rust-random#626 [rust-random#627]: rust-random#627 [`raw-dylib`]: https://doc.rust-lang.org/reference/items/external-blocks.html?highlight=link#dylib-versus-raw-dylib

Tweak Error representation
a40f305

newpavlov force-pushed the error_tweak branch from 0fbdc89 to a40f305Compare March 3, 2025 13:43

newpavlov requested a review from josephlr March 3, 2025 13:43

newpavlov added 2 commits March 3, 2025 16:48

Tweak note in last_os_error
f84c62e

Update changelog
0487236

newpavlov commented Mar 3, 2025
View reviewed changes

Comment threadsrc/error.rs Outdated

newpavlov added 3 commits March 3, 2025 16:57

Add link to the UEFI spec
cd61b0b

Remove Error size test
8102dd5

Hide deprecated constants
2dde619

josephlr reviewed Mar 5, 2025
View reviewed changes

Comment threadsrc/error.rs Outdated
Comment threadsrc/util_libc.rs
Comment threadsrc/error.rs Outdated
Comment threadsrc/error.rs Outdated

newpavlov added 5 commits March 5, 2025 17:32

Tweak handling of positive/negative code
84e9d58

Tweak handling of positive/negative codes
1ee2612

Tweak comments in Error::raw_os_error
dd3b3e2

Mark Error::INTERNAL_START and Error::CUSTOM_START as private
a39698d

Tweak Error docs
c8469be

newpavlov requested a review from josephlr March 5, 2025 16:56

Fix v0.3.2 link in changelog
ccc1258

josephlr approved these changes Mar 7, 2025
View reviewed changes

Comment threadsrc/error.rs Outdated

newpavlov added 5 commits March 7, 2025 12:22

Rename Error::from_os_error to from_neg_error_code. Add `Error::f…
4e8a6af
…rom_uefi_code`

Remove TEMP_EFI_ERROR
51d158b

Fix uefi
8395870

Gate from_neg_error_code on non-UEFI targets
5398021

Add #[allow(dead_code)] for from_uefi_code
897ae4a

newpavlov merged commit f2ede81 into masterMar 7, 2025

newpavlov deleted the error_tweak branch March 7, 2025 09:37

newpavlov mentioned this pull request Mar 7, 2025
Release v0.3.2 #617
Merged

newpavlov mentioned this pull request Apr 10, 2025
Fix documentation of fns rand_core::le::read_u*_into rust-random/rand#1626
Merged

Navigation Menu

Uh oh!

Tweak `Error` representation - #614

Tweak `Error` representation#614
newpavlov merged 17 commits into
masterfrom
error_tweak

newpavlov commented Mar 3, 2025•
edited
Loading

Uh oh!

Uh oh!

newpavlov commented Mar 3, 2025

Uh oh!

josephlr commented Mar 4, 2025

Uh oh!

josephlr left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

josephlr commented Mar 5, 2025

Uh oh!

josephlr left a comment

Uh oh!

Uh oh!

newpavlov commented Mar 7, 2025•
edited
Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

newpavlov commented Mar 3, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

newpavlov commented Mar 3, 2025

Uh oh!

josephlr commented Mar 4, 2025

Uh oh!

josephlr left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

josephlr commented Mar 5, 2025

Uh oh!

josephlr left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

newpavlov commented Mar 7, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

newpavlov commented Mar 3, 2025•
edited
Loading

newpavlov commented Mar 7, 2025•
edited
Loading