musli-zerocopy 0.0.134

Refreshingly simple zero copy primitives by Müsli.
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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135

#![allow(clippy::assertions_on_constants)]

use crate::endian::{Big, Little, Other};
use crate::{ByteOrder, Endian, ZeroCopy};

#[repr(C)]
struct Align<A, T: ?Sized>([A; 0], T);

#[test]
fn test_byte_order() {
    #[derive(ZeroCopy, PartialEq, Debug, Clone, Copy)]
    #[zero_copy(crate, swap_bytes)]
    #[repr(u32)]
    enum SomeEnum {
        A = 1,
        #[zero_copy(swap = A)]
        A_ = u32::swap_bytes(1),
        B = 2,
        #[zero_copy(swap = B)]
        B_ = u32::swap_bytes(2),
    }

    #[derive(ZeroCopy, Debug, Clone, Copy)]
    #[zero_copy(crate)]
    #[repr(C)]
    struct SomeStruct<T>
    where
        T: ByteOrder,
    {
        a: Endian<u32, T>,
        b: Endian<SomeEnum, T>,
    }

    let data: &[u8; 8] = &Align::<SomeStruct<Big>, _>([], [0, 0, 0, 1, 0, 0, 0, 2]).1;
    let st = SomeStruct::<Big>::from_bytes(data).unwrap();

    assert_eq!(st.a.to_ne(), 1);
    assert_eq!(st.b.to_ne(), SomeEnum::B);

    let data: &[u8; 8] = &Align::<SomeStruct<Little>, _>([], [1, 0, 0, 0, 2, 0, 0, 0]).1;
    let st = SomeStruct::<Little>::from_bytes(data).unwrap();

    assert_eq!(st.a.to_ne(), 1);
    assert_eq!(st.b.to_ne(), SomeEnum::B);
}

#[derive(ZeroCopy, PartialEq, Debug, Clone, Copy)]
#[zero_copy(crate)]
#[repr(u32)]
enum EnumNonSwapBytes {
    A = 1,
    A_ = u32::swap_bytes(1),
    B = 2,
    B_ = u32::swap_bytes(3),
}

const _: () = assert!(!EnumNonSwapBytes::CAN_SWAP_BYTES);

#[derive(ZeroCopy, PartialEq, Debug, Clone, Copy)]
#[zero_copy(crate, swap_bytes)]
#[repr(u32)]
enum EnumSwapBytesMismatch {
    A = 1,
    #[zero_copy(swap = A)]
    A_ = u32::swap_bytes(1),
    B = 2,
    #[zero_copy(swap = B)]
    B_ = u32::swap_bytes(3),
}

const _: () = assert!(!EnumSwapBytesMismatch::CAN_SWAP_BYTES);

#[test]
fn test_field_enum() {
    #[derive(ZeroCopy, PartialEq, Debug, Clone, Copy)]
    #[zero_copy(crate, swap_bytes)]
    #[repr(u32)]
    enum FieldEnum {
        A {
            field: u32,
        } = 1,
        #[zero_copy(swap = A)]
        OtherA {
            field: u32,
        } = u32::swap_bytes(1),
        B = 2,
        #[zero_copy(swap = B)]
        OtherB = u32::swap_bytes(2),
    }

    const _: () = assert!(FieldEnum::CAN_SWAP_BYTES);

    let a = FieldEnum::A { field: 42 };
    let a_ = a.swap_bytes::<Other>();
    assert_eq!(
        a_,
        FieldEnum::OtherA {
            field: u32::swap_bytes(42)
        }
    );

    let b = FieldEnum::B;
    let b_ = b.swap_bytes::<Other>();
    assert_eq!(b_, FieldEnum::OtherB);
}

#[test]
fn test_field_enum_implicit() {
    #[derive(ZeroCopy, PartialEq, Debug, Clone, Copy)]
    #[zero_copy(crate, swap_bytes)]
    #[repr(u32)]
    enum FieldEnumImplicit {
        A { field: u32 } = 1,
        A_ { field: u32 } = u32::swap_bytes(1),
        B = 2,
        B_ = u32::swap_bytes(2),
    }

    const _: () = assert!(FieldEnumImplicit::CAN_SWAP_BYTES);

    let a = FieldEnumImplicit::A { field: 42 };
    let a_ = a.swap_bytes::<Other>();

    let b = FieldEnumImplicit::B;
    let b_ = b.swap_bytes::<Other>();

    assert_eq!(
        a_,
        FieldEnumImplicit::A_ {
            field: u32::swap_bytes(42)
        }
    );

    assert_eq!(b_, FieldEnumImplicit::B_);
}