diff options
| author | Callum Leslie <git@cleslie.uk> | 2023-02-15 16:22:08 +0000 |
|---|---|---|
| committer | Callum Leslie <git@cleslie.uk> | 2023-02-15 16:22:08 +0000 |
| commit | 29621ba28876696a8dd01d746c49f3affc843c49 (patch) | |
| tree | 90be82f16cf3d5ae8fc0563e0d9d5531b58f76fe | |
| parent | 999ac5f7770bff68bd65f490990d32c3ec1faaa6 (diff) | |
| download | rust-29621ba28876696a8dd01d746c49f3affc843c49.tar.gz rust-29621ba28876696a8dd01d746c49f3affc843c49.zip | |
clarify correctness of `black_box`
| -rw-r--r-- | library/core/src/hint.rs | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/library/core/src/hint.rs b/library/core/src/hint.rs index 5a76e866923..ee13dae60b1 100644 --- a/library/core/src/hint.rs +++ b/library/core/src/hint.rs @@ -216,7 +216,8 @@ pub fn spin_loop() { /// /// Note however, that `black_box` is only (and can only be) provided on a "best-effort" basis. The /// extent to which it can block optimisations may vary depending upon the platform and code-gen -/// backend used. Programs cannot rely on `black_box` for *correctness* in any way. +/// backend used. Programs cannot rely on `black_box` for *correctness*, beyond it behaving as the +/// identity function. /// /// [`std::convert::identity`]: crate::convert::identity /// |