edlc_layout 0.1.0

derive layouts for EDL types
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55


# About

This library can be used to automatically derive the MIR layout from a rust type.
Currently, structs and enums are supported, unions are still work in progress.
Since EDL usually interfaces with Rust code that is compiled with the very same rustc version as the EDL compiler
itself, this derive macro does not require the data structs to be `#[repr(C)]`.
However, since there is currently no stable way to figure out where the Rust compiler places the discriminator in an
enum type, enums **must** be `#[repr(u8)]` if they are to be used with `MirLayout`.

# Examples

For all of the following examples, the data layout can be printed out using

```rust
#![feature(offset_of_enum, offset_of_nested)]

use std::sync::Arc;
use edlc_core::prelude::{EdlCompiler, mir_type::abi::AbiConfig, mir_type::layout::MirLayout};
use eqlang_layout::MirLayout;

fn main() {
    let mut compiler = EdlCompiler::new();
    compiler.push_core_types().unwrap();
    compiler.push_core_traits().unwrap();
    compiler.prepare_mir().unwrap();

    let types = &compiler.mir_phase.types;
    println!("{}", Example::layout(types));
}
```

## Example struct

```rust
#[derive(MirLayout)]
struct Example {
    a: u32,
    b: u8,
    c: u8,
    d: f32,
}
```

## Example enum

```rust
#[derive(MirLayout)]
#[repr(u8)]
enum Example {
    A(f32, f32),
    B(u16, u32, f32),
    C(u8, u16, u8, u8, f64),
}
```