Giter Club home page Giter Club logo

addr_of_enum's Introduction

addr_of_enum

This crate provides #[derive(AddrOfEnum)] and addr_of_enum! macro to get a field pointer of specified variant without creating an intermediated reference. It works like std::ptr::addr_of!, but works only on enums.

This macro is zero-cost, which means that it calculates without minimum cost in release mode.

It also works on variables which has uninhabited types.

Example

# use addr_of_enum::{addr_of_enum, AddrOfEnum};

#[derive(AddrOfEnum)]
#[repr(C)]
enum MyEnum {
    E1(usize, u8),
    E2 {
        item1: u32,
        item2: u8,
    }
}

let e = MyEnum::E1(1, 2);
let _: *const usize = addr_of_enum!(&e, E1, 0);
let _: *const u32 = addr_of_enum!(&e, E2, item1);

Limitations

For now, the macros cannot be used in const context.

addr_of_enum's People

Contributors

yasuo-ozu avatar

Stargazers

orzogc avatar Naoki Ikeguchi avatar

Watchers

 avatar

addr_of_enum's Issues

Unsoundness caused by different `GhostEnum` layout

Unfortunately this crate currently relies on the assumption that an enum containing fields of type T has the same layout as an enum containing MaybeUninit<T>. However, this is not always the case. It is mentioned in the rust docs of MaybeUninit that

types containing a field of type T may be laid out (and sized) differently than if that field were MaybeUninit<T>

Here is a test that fails for that reason:

#[derive(AddrOfEnum, PartialEq, Eq)]
enum MyOption<T> {
    None,
    Some(T),
}

#[test]
fn test_option() {
    let some = MyOption::Some(false);

    match &some {
        MyOption::Some(item) => {
            assert_eq!(item as *const bool, addr_of_enum!(&some, Some, 0)); // <- this will fail (off by one)
        }
        _ => panic!(),
    }
}

In this specific example, the compiler does niche optimization because it knows that only 0 and 1 are valid values for bool, so it can use one of the remaining values as None. However, MaybeUninit<bool> could, by definition, have any bit pattern, so the same optimization is not possible there.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.