yog-abi 0.36.0

Yog stable C ABI — the shared contract between mods and the runtime.
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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

//! The ABI's layout and version checks.

use super::*;
use std::mem::{align_of, size_of};

/// Sizes and alignments of every type crossing the ABI, folded together.
fn layout_fingerprint() -> u64 {
    macro_rules! layouts {
        ($($t:ty),* $(,)?) => { [$((stringify!($t), size_of::<$t>(), align_of::<$t>())),*] };
    }
    let all = layouts!(
        YogStr,
        YogGfxApi,
        YogApi,
        YogBytes,
        YogReply,
        YogBus,
        YogColumn,
        YogKeySlot,
        YogKeySpace,
    );
    // FNV-1a over (name, size, align).
    let mut h: u64 = 0xcbf2_9ce4_8422_2325;
    for (name, size, align) in all {
        for b in name
            .bytes()
            .chain((size as u64).to_le_bytes())
            .chain((align as u64).to_le_bytes())
        {
            h = (h ^ b as u64).wrapping_mul(0x0100_0000_01b3);
        }
    }
    h
}

/// A type crossing the ABI changed without `ABI_VERSION` changing: bump
/// `ABI_MINOR` (fields appended at the end) or `ABI_MAJOR` (anything
/// else), then record the new fingerprint here.
#[test]
#[cfg(target_pointer_width = "64")]
fn the_layout_matches_its_version() {
    assert_eq!(
        (ABI_VERSION, layout_fingerprint()),
        (60000, 0x4936_1429_1f05_c09e),
        "layout fingerprint: {:#x}",
        layout_fingerprint()
    );
}

#[test]
fn older_minors_of_the_major_are_compatible() {
    assert!(compatible(ABI_VERSION));
    assert!(compatible(ABI_MAJOR * 10_000));
    assert!(
        !compatible(ABI_VERSION + 1),
        "a newer minor may use what isn't here"
    );
    assert!(
        !compatible((ABI_MAJOR - 1) * 10_000 + ABI_MINOR),
        "another major"
    );
    assert!(!compatible((ABI_MAJOR + 1) * 10_000));
}

#[test]
fn strings_cross_and_come_back() {
    let s = YogStr::from_str("Ünïcode ✓");
    assert_eq!(unsafe { s.as_str() }, "Ünïcode ✓");
    assert!(YogStr::EMPTY.is_empty());
    assert_eq!(unsafe { YogStr::EMPTY.as_str() }, "");
}