Make vendor available.

Bug: 198197213
Test: N/A
Change-Id: I355bccf504c72456171c5fb96714bcd9676e46fa
2 files changed
tree: 440e8cad7d8e81208069a87cf2d47e9e892e4285
  1. ci/
  2. patches/
  3. src/
  4. .cargo_vcs_info.json
  5. .gitignore
  6. .travis.yml
  7. Android.bp
  8. build.rs
  9. Cargo.toml
  10. Cargo.toml.orig
  11. cargo2android.json
  12. LICENSE
  13. METADATA
  14. MODULE_LICENSE_MIT
  15. OWNERS
  16. README.md
  17. TEST_MAPPING
README.md

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.6"

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

Add the following lines at the top of your main.rs or lib.rs files.

#[macro_use]
extern crate memoffset;

Examples

#[macro_use]
extern crate memoffset;

#[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.6"
features = ["unstable_const"]

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

#![feature(const_ptr_offset_from, const_maybe_uninit_as_ptr, const_raw_ptr_deref, const_refs_to_cell)]