Skip to content

Commit 346303b

Browse files
committed
doc: mention that intrinsics should not be called in user code
Intrinsic functions declared in `std::intrinsics` are an implementation detail and should not be called directly by the user. The compiler explicitly warns against their use in user code: ``` warning: the feature `core_intrinsics` is internal to the compiler or standard library --> src/lib.rs:1:12 | 1 | #![feature(core_intrinsics)] | ^^^^^^^^^^^^^^^ | = note: using it is strongly discouraged = note: `#[warn(internal_features)]` on by default ``` [**Playground link**] This PR documents what the compiler warning says: these intrinsics should not be used outside the user code. So far only I added a note to intrinsics that have a clearly documented stable equivalent. I will add the same note to the other intrinsics in a followup PR. [**Playground link**]: https://play.rust-lang.org/?version=nightly&mode=debug&edition=2024&gist=1c893b0698291f550bbdde0151fd221b
1 parent 6c8138d commit 346303b

File tree

1 file changed

+339
-181
lines changed
  • library/core/src/intrinsics

1 file changed

+339
-181
lines changed

0 commit comments

Comments
 (0)