mirror of
https://github.com/Lokathor/bytemuck.git
synced 2024-11-21 14:22:26 +00:00
Improve documentation of features. (#272)
* Improve documentation of nightly features * Document undocumented features
This commit is contained in:
parent
860c391345
commit
bb368799c3
11
Cargo.toml
11
Cargo.toml
@ -13,10 +13,16 @@ exclude = ["/pedantic.bat"]
|
|||||||
|
|
||||||
[features]
|
[features]
|
||||||
# In v2 we'll fix these names to be more "normal".
|
# In v2 we'll fix these names to be more "normal".
|
||||||
|
|
||||||
|
# Enable deriving the various `bytemuck` traits.
|
||||||
derive = ["bytemuck_derive"]
|
derive = ["bytemuck_derive"]
|
||||||
|
# Enable features requiring items from `extern crate alloc`.
|
||||||
extern_crate_alloc = []
|
extern_crate_alloc = []
|
||||||
|
# Enable features requiring items from `extern crate std`.
|
||||||
extern_crate_std = ["extern_crate_alloc"]
|
extern_crate_std = ["extern_crate_alloc"]
|
||||||
|
# Implement `Zeroable` for `MaybeUninit`.
|
||||||
zeroable_maybe_uninit = []
|
zeroable_maybe_uninit = []
|
||||||
|
# Implement `Zeroable` for `std::sync::atomic` types.
|
||||||
zeroable_atomics = []
|
zeroable_atomics = []
|
||||||
|
|
||||||
# All MSRV notes below are GUIDELINES and future versions may require even more
|
# All MSRV notes below are GUIDELINES and future versions may require even more
|
||||||
@ -56,8 +62,11 @@ latest_stable_rust = [
|
|||||||
"zeroable_maybe_uninit",
|
"zeroable_maybe_uninit",
|
||||||
]
|
]
|
||||||
|
|
||||||
# NOT SEMVER SUPPORTED! TEMPORARY ONLY!
|
# ALL FEATURES BELOW THIS ARE NOT SEMVER SUPPORTED! TEMPORARY ONLY!
|
||||||
|
|
||||||
|
# Enable support for `std::simd` types.
|
||||||
nightly_portable_simd = []
|
nightly_portable_simd = []
|
||||||
|
# Enable support for unstable `std::arch` types (such as the AVX512 types).
|
||||||
nightly_stdsimd = []
|
nightly_stdsimd = []
|
||||||
# Enable `f16` and `f128`
|
# Enable `f16` and `f128`
|
||||||
nightly_float = []
|
nightly_float = []
|
||||||
|
Loading…
Reference in New Issue
Block a user