|
2 | 2 |
|
3 | 3 | //! Build-time error.
|
4 | 4 | //!
|
5 |
| -//! This crate provides a function `build_error`, which will panic in |
6 |
| -//! compile-time if executed in const context, and will cause a build error |
7 |
| -//! if not executed at compile time and the optimizer does not optimise away the |
8 |
| -//! call. |
| 5 | +//! This crate provides a [const function][const-functions] `build_error`, which will panic in |
| 6 | +//! compile-time if executed in [const context][const-context], and will cause a build error |
| 7 | +//! if not executed at compile time and the optimizer does not optimise away the call. |
9 | 8 | //!
|
10 | 9 | //! It is used by `build_assert!` in the kernel crate, allowing checking of
|
11 | 10 | //! conditions that could be checked statically, but could not be enforced in
|
12 |
| -//! Rust yet (e.g. perform some checks in const functions, but those |
| 11 | +//! Rust yet (e.g. perform some checks in [const functions][const-functions], but those |
13 | 12 | //! functions could still be called in the runtime).
|
| 13 | +//! |
| 14 | +//! For details on constant evaluation in Rust, please see the [Reference][const-eval]. |
| 15 | +//! |
| 16 | +//! [const-eval]: https://doc.rust-lang.org/reference/const_eval.html |
| 17 | +//! [const-functions]: https://doc.rust-lang.org/reference/const_eval.html#const-functions |
| 18 | +//! [const-context]: https://doc.rust-lang.org/reference/const_eval.html#const-context |
14 | 19 |
|
15 | 20 | #![no_std]
|
16 | 21 |
|
17 |
| -/// Panics if executed in const context, or triggers a build error if not. |
| 22 | +/// Panics if executed in [const context][const-context], or triggers a build error if not. |
| 23 | +/// |
| 24 | +/// [const-context]: https://doc.rust-lang.org/reference/const_eval.html#const-context |
18 | 25 | #[inline(never)]
|
19 | 26 | #[cold]
|
20 | 27 | #[export_name = "rust_build_error"]
|
|
0 commit comments