mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Rollup merge of #108088 - callumio:issue-107957, r=dtolnay

Browse Source 
clarify correctness of `black_box`

Resolves #107957, as described in the related issue.

No code changes, just documentation.
This commit is contained in:
Matthias Krüger 2023-02-15 21:30:59 +01:00 committed by GitHub
commit 863cd15132
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
library/core/src/hint.rs
View File

@ -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
///