#derive #offset-of #mem #offset

macro no-std repr_offset_derive

For deriving the offsets of fields for types with a stable layout

4 releases (2 breaking)

0.2.0 Jan 29, 2021
0.1.1 Jul 30, 2020
0.1.0 Jun 14, 2020
0.0.0 May 21, 2020

#13 in #mem

Download history 49/week @ 2023-10-28 36/week @ 2023-11-04 43/week @ 2023-11-11 45/week @ 2023-11-18 58/week @ 2023-11-25 59/week @ 2023-12-02 54/week @ 2023-12-09 52/week @ 2023-12-16 45/week @ 2023-12-23 38/week @ 2023-12-30 45/week @ 2024-01-06 46/week @ 2024-01-13 46/week @ 2024-01-20 45/week @ 2024-01-27 37/week @ 2024-02-03 60/week @ 2024-02-10

196 downloads per month
Used in repr_offset

Zlib license

16KB
348 lines

Rust crates-io api-docs

repr_offset allows computing and safely using field offsets from types with a defined layout.

Currently only #[repr(C)]/#[repr(C,packed)]/#[repr(C,align)] structs are supported.

Features

These are some of the features this library provides:

  • The ReprOffset derive macro, which outputs associated constants with the offsets of fields, and implements the GetFieldOffset trait for each field.

  • The FieldOffset type (how offsets are represented), with methods for operating on a field through a pointer to the struct, including getting a reference(or pointer) to the field.

  • The unsafe_struct_field_offsets macro as an alternative to the ReprOffset derive macro, most useful when the "derive" feature is disabled.

  • The GetFieldOffset trait, for getting the FieldOffset for a field, and the OFF!, off, PUB_OFF!, and pub_off macros for getting the FieldOffset for a field with a convenient syntax.

  • The extension traits from the ext module, which define methods for operating on a field, given a FieldOffset.

Examples

For examples you can look at the examples section of the documentation for the root module of the repr_offset crate

Future plans

None for now.

Cargo features

These are the cargo features in repr_offset:

  • derive (disabled by default): Enables the ReprOffset derive macro. This requires the same Rust versions as syn, which is currently >= 1.56.0.

  • "for_examples" (disabled by default): Enables the for_examples module, with types used in documentation examples.

Adding the "derive" feature to the Cargo.toml file:

repr_offset = { version = "0.2", features = ["derive"] }

no-std support

This library is unconditionally #![no_std],and that is unlikely to change in the future.

Minimum Rust version

This crate support Rust back to 1.41.0.

License

Licensed under the Zlib license

Dependencies

~1.5–2.5MB
~53K SLoC