Automatically enable const evaluation

When running on a compiler newer than 1.65,
automatically enable usage of the macro in const contexts.

Closes https://github.com/Gilnaa/memoffset/issues/4
This commit is contained in:
Gilad Naaman 2022-12-11 21:53:36 +02:00
parent d8accb7671
commit 923a5f2386
5 changed files with 34 additions and 10 deletions

View File

@ -33,6 +33,7 @@ jobs:
- 1.36.0 # Oldest supported with MaybeUninit - 1.36.0 # Oldest supported with MaybeUninit
- 1.40.0 # Oldest supported with cfg(doctest) - 1.40.0 # Oldest supported with cfg(doctest)
- 1.51.0 # Oldest supported with ptr::addr_of! - 1.51.0 # Oldest supported with ptr::addr_of!
- 1.65.0 # Oldest supported with stable const evaluation (sans cell)
- stable - stable
- beta - beta
- nightly - nightly

View File

@ -45,12 +45,23 @@ fn main() {
} }
``` ```
## Feature flags ## ## Usage in constants ##
`memoffset` has support for compile-time `offset_of!` on rust>=1.65, or on older nightly compilers.
### Usage in constants ### ### Usage on stable Rust ###
`memoffset` has **experimental** support for compile-time `offset_of!` on a nightly compiler. Constant evaluation is automatically enabled and avilable on stable compilers starting with rustc 1.65.
In order to use it, you must enable the `unstable_const` crate feature and several compiler features. This is an incomplete implementation with one caveat:
Due to dependence on [`#![feature(const_refs_to_cell)]`](https://github.com/rust-lang/rust/issues/80384), you cannot get the offset of a `Cell` field in a const-context.
This means that if need to get the offset of a cell, you'll have to remain on nightly for now.
### Usage on recent nightlies ###
If you're using a new-enough nightly and you require the ability to get the offset of a `Cell`,
you'll have to enable the `unstable_const` cargo feature, as well as enabling `const_refs_to_cell` in your crate root.
Do note that `unstable_const` is an unstable feature that is set to be removed in a future version of `memoffset`.
Cargo.toml: Cargo.toml:
```toml ```toml
@ -59,6 +70,14 @@ version = "0.7"
features = ["unstable_const"] features = ["unstable_const"]
``` ```
Your crate root: (`lib.rs`/`main.rs`)
```rust,ignore
#![feature(const_refs_to_cell)]
```
### Usage on older nightlies ###
In order to use it on an older nightly compiler, you must enable the `unstable_const` crate feature and several compiler features.
Your crate root: (`lib.rs`/`main.rs`) Your crate root: (`lib.rs`/`main.rs`)
```rust,ignore ```rust,ignore
#![feature(const_ptr_offset_from, const_refs_to_cell)] #![feature(const_ptr_offset_from, const_refs_to_cell)]

View File

@ -19,4 +19,7 @@ fn main() {
if ac.probe_rustc_version(1, 51) { if ac.probe_rustc_version(1, 51) {
println!("cargo:rustc-cfg=raw_ref_macros"); println!("cargo:rustc-cfg=raw_ref_macros");
} }
if ac.probe_rustc_version(1, 65) {
println!("cargo:rustc-cfg=stable_const");
}
} }

View File

@ -57,9 +57,10 @@
#![no_std] #![no_std]
#![cfg_attr( #![cfg_attr(
feature = "unstable_const", all(feature = "unstable_const", not(stable_const)),
feature(const_ptr_offset_from, const_refs_to_cell) feature(const_ptr_offset_from)
)] )]
#![cfg_attr(feature = "unstable_const", feature(const_refs_to_cell))]
#[macro_use] #[macro_use]
#[cfg(doctests)] #[cfg(doctests)]

View File

@ -46,7 +46,7 @@ macro_rules! _memoffset__let_base_ptr {
} }
/// Macro to compute the distance between two pointers. /// Macro to compute the distance between two pointers.
#[cfg(feature = "unstable_const")] #[cfg(any(feature = "unstable_const", stable_const))]
#[macro_export] #[macro_export]
#[doc(hidden)] #[doc(hidden)]
macro_rules! _memoffset_offset_from_unsafe { macro_rules! _memoffset_offset_from_unsafe {
@ -58,7 +58,7 @@ macro_rules! _memoffset_offset_from_unsafe {
unsafe { (field as *const u8).offset_from(base as *const u8) as usize } unsafe { (field as *const u8).offset_from(base as *const u8) as usize }
}}; }};
} }
#[cfg(not(feature = "unstable_const"))] #[cfg(not(any(feature = "unstable_const", stable_const)))]
#[macro_export] #[macro_export]
#[doc(hidden)] #[doc(hidden)]
macro_rules! _memoffset_offset_from_unsafe { macro_rules! _memoffset_offset_from_unsafe {
@ -312,7 +312,7 @@ mod tests {
assert_eq!(f_ptr as usize + 0, raw_field_union!(f_ptr, Foo, c) as usize); assert_eq!(f_ptr as usize + 0, raw_field_union!(f_ptr, Foo, c) as usize);
} }
#[cfg(feature = "unstable_const")] #[cfg(any(feature = "unstable_const", stable_const))]
#[test] #[test]
fn const_offset() { fn const_offset() {
#[repr(C)] #[repr(C)]
@ -337,7 +337,7 @@ mod tests {
assert_eq!([0; offset_of!(Foo, b)].len(), 4); assert_eq!([0; offset_of!(Foo, b)].len(), 4);
} }
#[cfg(feature = "unstable_const")] #[cfg(any(feature = "unstable_const", stable_const))]
#[test] #[test]
fn const_fn_offset() { fn const_fn_offset() {
const fn test_fn() -> usize { const fn test_fn() -> usize {