android13/external/rust/crates/memoffset
liiir1985 7f62dcda9f initial 2024-06-22 20:45:49 +08:00
..
.github/workflows initial 2024-06-22 20:45:49 +08:00
ci initial 2024-06-22 20:45:49 +08:00
patches initial 2024-06-22 20:45:49 +08:00
src initial 2024-06-22 20:45:49 +08:00
.cargo_vcs_info.json initial 2024-06-22 20:45:49 +08:00
Android.bp initial 2024-06-22 20:45:49 +08:00
Cargo.toml initial 2024-06-22 20:45:49 +08:00
Cargo.toml.orig initial 2024-06-22 20:45:49 +08:00
LICENSE initial 2024-06-22 20:45:49 +08:00
METADATA initial 2024-06-22 20:45:49 +08:00
MODULE_LICENSE_MIT initial 2024-06-22 20:45:49 +08:00
OWNERS initial 2024-06-22 20:45:49 +08:00
README.md initial 2024-06-22 20:45:49 +08:00
TEST_MAPPING initial 2024-06-22 20:45:49 +08:00
build.rs initial 2024-06-22 20:45:49 +08:00
cargo2android.json initial 2024-06-22 20:45:49 +08:00

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.

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

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

#![feature(const_ptr_offset_from, const_refs_to_cell)]