Go to file
Gilad Naaman d8accb7671 Version 0.7.1
Re-publish with updated README
2022-10-17 09:29:35 +03:00
.github/workflows update Miri CI config 2022-03-08 13:16:23 -05:00
src Update docs WRT repr(Rust) (#69) 2022-10-16 16:49:41 +02:00
.gitignore Bumped version to 0.2 2018-01-13 19:37:05 +02:00
build.rs Use stablilized addr_of! macro (#50) 2021-03-08 19:56:59 +01:00
Cargo.toml Version 0.7.1 2022-10-17 09:29:35 +03:00
LICENSE Switched to the MIT license 2017-10-17 08:37:35 +03:00
README.md Updated version in README 2022-10-17 09:28:40 +03:00

memoffset

C-Like offset_of functionality for Rust structs.

Introduces the following macros:

  • offset_of! for obtaining the offset of a member of a struct.
  • offset_of_tuple! for obtaining the offset of a member of a tuple. (Requires Rust 1.20+)
  • span_of! for obtaining the range that a field, or fields, span.

memoffset works under no_std environments.

Usage

Add the following dependency to your Cargo.toml:

[dependencies]
memoffset = "0.7"

These versions will compile fine with rustc versions greater or equal to 1.19.

Examples

use memoffset::{offset_of, span_of};

#[repr(C, packed)]
struct Foo {
    a: u32,
    b: u32,
    c: [u8; 5],
    d: u32,
}

fn main() {
    assert_eq!(offset_of!(Foo, b), 4);
    assert_eq!(offset_of!(Foo, d), 4+4+5);

    assert_eq!(span_of!(Foo, a),        0..4);
    assert_eq!(span_of!(Foo, a ..  c),  0..8);
    assert_eq!(span_of!(Foo, a ..= c),  0..13);
    assert_eq!(span_of!(Foo, ..= d),    0..17);
    assert_eq!(span_of!(Foo, b ..),     4..17);
}

Feature flags

Usage in constants

memoffset has experimental support for compile-time offset_of! on a nightly compiler.

In order to use it, you must enable the unstable_const crate feature and several compiler features.

Cargo.toml:

[dependencies.memoffset]
version = "0.7"
features = ["unstable_const"]

Your crate root: (lib.rs/main.rs)

#![feature(const_ptr_offset_from, const_refs_to_cell)]