clarify correctness of black_box

This commit is contained in:
Callum Leslie 2023-02-15 16:22:08 +00:00
parent 999ac5f777
commit 29621ba288
No known key found for this signature in database
GPG Key ID: D382C4AFEECEAA90

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