Skip to content

Commit 6b34c80

Browse files
newpavlovnewpavlov
committed
Add opt_in crate feature
1 parent 6be4012 commit 6b34c80

6 files changed

Lines changed: 30 additions & 28 deletions

File tree

‎.github/workflows/build.yml‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -121,13 +121,13 @@ jobs:
121121
- run: cargo build --target=${{ matrix.target }} --features=std
122122
- env:
123123
RUSTFLAGS: -Dwarnings --cfg getrandom_backend="linux_getrandom"
124-
run: cargo build --target=${{ matrix.target }} --features=std
124+
run: cargo build --target=${{ matrix.target }} --features=std,opt_in
125125
- env:
126126
RUSTFLAGS: -Dwarnings --cfg getrandom_test_linux_fallback
127127
run: cargo build --features=std
128128
- env:
129129
RUSTFLAGS: -Dwarnings --cfg getrandom_backend="rdrand"
130-
run: cargo build --features=std
130+
run: cargo build --features=std,opt_in
131131

132132
web:
133133
name: ${{ matrix.target.description }} ${{ matrix.feature.description }} ${{ matrix.atomic.description }}
@@ -180,10 +180,10 @@ jobs:
180180
- uses: Swatinem/rust-cache@v2
181181
- env:
182182
RUSTFLAGS: -Dwarnings --cfg getrandom_backend="rdrand"
183-
run: cargo build -Z build-std=core --target=${{ matrix.target }}
183+
run: cargo build -Z build-std=core --target=${{ matrix.target }} --features opt_in
184184
- env:
185185
RUSTFLAGS: -Dwarnings --cfg getrandom_backend="rdrand"
186-
run: cargo build -Z build-std=std --target=${{ matrix.target }} --features std
186+
run: cargo build -Z build-std=std --target=${{ matrix.target }} --features std,opt_in
187187

188188
rndr:
189189
name: RNDR
@@ -198,15 +198,15 @@ jobs:
198198
- name: RNDR enabled at compile time (Linux)
199199
env:
200200
RUSTFLAGS: -Dwarnings --cfg getrandom_backend="rndr" -C target-feature=+rand
201-
run: cargo build --target=aarch64-unknown-linux-gnu
201+
run: cargo build --target=aarch64-unknown-linux-gnu --features opt_in
202202
- name: Runtime RNDR detection without std (Linux)
203203
env:
204204
RUSTFLAGS: -Dwarnings --cfg getrandom_backend="rndr"
205-
run: cargo build --target=aarch64-unknown-linux-gnu
205+
run: cargo build --target=aarch64-unknown-linux-gnu --features opt_in
206206
- name: Runtime RNDR detection with std (macOS)
207207
env:
208208
RUSTFLAGS: -Dwarnings --cfg getrandom_backend="rndr"
209-
run: cargo build --target=aarch64-unknown-linux-gnu --features std
209+
run: cargo build --target=aarch64-unknown-linux-gnu --features std,opt_in
210210

211211
no-atomics:
212212
name: No Atomics
@@ -219,4 +219,4 @@ jobs:
219219
- uses: Swatinem/rust-cache@v2
220220
- env:
221221
RUSTFLAGS: -Dwarnings --cfg getrandom_backend="custom"
222-
run: cargo build --target riscv32i-unknown-none-elf
222+
run: cargo build --target riscv32i-unknown-none-elf --features opt_in

‎.github/workflows/nopanic.yaml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,21 +45,21 @@ jobs:
4545
- name: Build (linux_android.rs)
4646
env:
4747
RUSTFLAGS: -Dwarnings --cfg getrandom_backend="linux_getrandom"
48-
run: cargo build --release
48+
run: cargo build --release --features=opt_in
4949
- name: Check (linux_android.rs)
5050
run: (exit $( grep -c panic target/release/libgetrandom_wrapper.so ))
5151

5252
- name: Build (rdrand.rs)
5353
env:
5454
RUSTFLAGS: -Dwarnings --cfg getrandom_backend="rdrand"
55-
run: cargo build --release
55+
run: cargo build --release --features=opt_in
5656
- name: Check (rdrand.rs)
5757
run: (exit $( grep -c panic target/release/libgetrandom_wrapper.so ))
5858

5959
- name: Build (custom.rs)
6060
env:
6161
RUSTFLAGS: -Dwarnings --cfg getrandom_backend="custom"
62-
run: cargo build --release
62+
run: cargo build --release --features=opt_in
6363
- name: Check (custom.rs)
6464
run: (exit $( grep -c panic target/release/libgetrandom_wrapper.so ))
6565

@@ -94,7 +94,7 @@ jobs:
9494
- name: Build (rndr.rs)
9595
env:
9696
RUSTFLAGS: -Dwarnings --cfg getrandom_backend="rndr"
97-
run: cross build --release --target=aarch64-unknown-linux-gnu
97+
run: cross build --release --target=aarch64-unknown-linux-gnu --features=opt_in
9898
- name: Check (rndr.rs)
9999
run: (exit $( grep -c panic target/aarch64-unknown-linux-gnu/release/libgetrandom_wrapper.so ))
100100

‎.github/workflows/tests.yml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,13 +55,13 @@ jobs:
5555
- run: cargo test --target=${{ matrix.target }} --features=std
5656
- env:
5757
RUSTFLAGS: -Dwarnings --cfg getrandom_backend="linux_getrandom"
58-
run: cargo test --target=${{ matrix.target }} --features=std
58+
run: cargo test --target=${{ matrix.target }} --features=std,opt_in
5959
- env:
6060
RUSTFLAGS: -Dwarnings --cfg getrandom_test_linux_fallback
6161
run: cargo test --features=std
6262
- env:
6363
RUSTFLAGS: -Dwarnings --cfg getrandom_backend="rdrand"
64-
run: cargo test --features=std
64+
run: cargo test --features=std,opt_in
6565

6666
ios:
6767
name: iOS Simulator
@@ -238,14 +238,14 @@ jobs:
238238
description: Web,
239239
version: stable,
240240
flags: -Dwarnings --cfg getrandom_backend="wasm_js",
241-
args: --features=std,
241+
args: '--features=std,opt_in',
242242
}
243243
- {
244244
description: Web with Atomics,
245245
version: nightly,
246246
components: rust-src,
247247
flags: '-Dwarnings --cfg getrandom_backend="wasm_js" -Ctarget-feature=+atomics,+bulk-memory',
248-
args: '--features=std -Zbuild-std=panic_abort,std',
248+
args: '--features=std,opt_in -Zbuild-std=panic_abort,std',
249249
}
250250
steps:
251251
- uses: actions/checkout@v4

‎.github/workflows/workspace.yml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,15 +48,15 @@ jobs:
4848
- name: Web WASM (wasm_js.rs)
4949
env:
5050
RUSTFLAGS: -Dwarnings --cfg getrandom_backend="wasm_js"
51-
run: cargo clippy -Zbuild-std --target wasm32-unknown-unknown
51+
run: cargo clippy -Zbuild-std --target wasm32-unknown-unknown --features=opt_in
5252
- name: Web WASM with atomics (wasm_js.rs)
5353
env:
5454
RUSTFLAGS: -Dwarnings --cfg getrandom_backend="wasm_js" -Ctarget-feature=+atomics,+bulk-memory
55-
run: cargo clippy -Zbuild-std --target wasm32-unknown-unknown
55+
run: cargo clippy -Zbuild-std --target wasm32-unknown-unknown --features=opt_in
5656
- name: Linux (linux_android.rs)
5757
env:
5858
RUSTFLAGS: -Dwarnings --cfg getrandom_backend="linux_getrandom"
59-
run: cargo clippy --target x86_64-unknown-linux-gnu
59+
run: cargo clippy --target x86_64-unknown-linux-gnu --features=opt_in
6060
- name: Linux (linux_android_with_fallback.rs)
6161
run: cargo clippy --target x86_64-unknown-linux-gnu
6262
- name: NetBSD (netbsd.rs)
@@ -66,7 +66,7 @@ jobs:
6666
- name: RNDR (rndr.rs)
6767
env:
6868
RUSTFLAGS: -Dwarnings --cfg getrandom_backend="rndr"
69-
run: cargo clippy -Zbuild-std=core --target aarch64-unknown-linux-gnu
69+
run: cargo clippy -Zbuild-std=core --target aarch64-unknown-linux-gnu --features=opt_in
7070
- name: Solaris (solaris.rs)
7171
run: cargo clippy -Zbuild-std=core --target x86_64-pc-solaris
7272
- name: SOLID (solid.rs)

‎Cargo.toml‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ compiler_builtins = { version = "0.1", optional = true }
1919
core = { version = "1.0", optional = true, package = "rustc-std-workspace-core" }
2020

2121
# linux_android / linux_android_with_fallback
22-
[target.'cfg(all(any(target_os = "linux", target_os = "android"), not(any(target_env = "", getrandom_backend = "custom"))))'.dependencies]
22+
[target.'cfg(any(target_os = "linux", target_os = "android"))'.dependencies]
2323
libc = { version = "0.2.154", default-features = false }
2424

2525
# apple-other
@@ -60,16 +60,18 @@ windows-targets = "0.52"
6060

6161
# wasm_js
6262
[target.'cfg(all(getrandom_backend = "wasm_js", target_arch = "wasm32", any(target_os = "unknown", target_os = "none")))'.dependencies]
63-
wasm-bindgen = { version = "0.2.98", default-features = false }
63+
wasm-bindgen = { version = "0.2.98", default-features = false, optional = true }
6464
[target.'cfg(all(getrandom_backend = "wasm_js", target_arch = "wasm32", any(target_os = "unknown", target_os = "none"), target_feature = "atomics"))'.dependencies]
65-
js-sys = { version = "0.3.77", default-features = false }
65+
js-sys = { version = "0.3.77", default-features = false, optional = true }
6666
[target.'cfg(all(getrandom_backend = "wasm_js", target_arch = "wasm32", any(target_os = "unknown", target_os = "none")))'.dev-dependencies]
6767
wasm-bindgen-test = "0.3"
6868

6969
[features]
7070
# Implement std::error::Error for getrandom::Error and
7171
# use std to retrieve OS error descriptions
7272
std = []
73+
# Enable opt-in backends
74+
opt_in = []
7375
# Unstable feature to support being a libstd dependency
7476
rustc-dep-of-std = ["dep:compiler_builtins", "dep:core"]
7577

‎src/backends.rs‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,19 @@
77
//! regardless of what value it returns.
88
99
cfg_if! {
10-
if #[cfg(getrandom_backend = "custom")] {
10+
if #[cfg(all(feature = "opt_in",getrandom_backend = "custom"))] {
1111
mod custom;
1212
pub use custom::*;
13-
} else if #[cfg(getrandom_backend = "linux_getrandom")] {
13+
} else if #[cfg(all(feature = "opt_in", getrandom_backend = "linux_getrandom"))] {
1414
mod linux_android;
1515
pub use linux_android::*;
16-
} else if #[cfg(getrandom_backend = "rdrand")] {
16+
} else if #[cfg(all(feature = "opt_in", getrandom_backend = "rdrand"))] {
1717
mod rdrand;
1818
pub use rdrand::*;
19-
} else if #[cfg(getrandom_backend = "rndr")] {
19+
} else if #[cfg(all(feature = "opt_in", getrandom_backend = "rndr"))] {
2020
mod rndr;
2121
pub use rndr::*;
22-
} else if #[cfg(getrandom_backend = "wasm_js")] {
22+
} else if #[cfg(all(feature = "opt_in", getrandom_backend = "wasm_js"))] {
2323
mod wasm_js;
2424
pub use wasm_js::*;
2525
} else if #[cfg(target_os = "espidf")] {

0 commit comments

Comments
 (0)
⚡