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

Document newtype_index attributes.

Browse Source
This commit is contained in:
Nicholas Nethercote 2023-11-21 18:42:34 +11:00
parent 7060fc8327
commit 0991374bd1
1 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
compiler/rustc_index_macros/src/lib.rs
View File

@ -18,8 +18,19 @@
/// to create/return a value. /// to create/return a value.
/// ///
/// Internally, the index uses a u32, so the index must not exceed /// Internally, the index uses a u32, so the index must not exceed
/// `u32::MAX`. You can also customize things like the `Debug` impl, /// `u32::MAX`.
/// what traits are derived, and so forth via the macro. ///
/// The impls provided by default are Clone, Copy, PartialEq, Eq, and Hash.
///
/// Accepted attributes for customization:
/// - #[derive(HashStable_Generic)]/#[derive(HashStable)]: derives
/// `HashStable`, as normal.
/// - #[encodable]: derives `Encodable`/`Decodable`.
/// - #[orderable]: derives `PartialOrd`/`Ord`, plus step-related methods.
/// - #[debug_format = "Foo({})"]: derives `Debug` with particular output.
/// - #[max = 0xFFFF_FFFD]: specifies the max value, which allows niche
/// optimizations. The default max value is 0xFFFF_FF00.
/// - #[gate_rustc_only]: makes parts of the generated code nightly-only.
#[proc_macro] #[proc_macro]
#[cfg_attr( #[cfg_attr(
feature = "nightly", feature = "nightly",