zc 0.4.0

Self-referential zero-copy structure
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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151

use zc::aliasable::{boxed::AliasableBox, vec::AliasableVec};
use zc::{Dependant, Zc};

#[derive(Dependant)]
pub struct StructWithNoLifetime;

#[derive(Dependant)]
pub struct ChildType<'a>(&'a ());

#[derive(Dependant)]
pub struct StructWithOneLifetime<'a>(ChildType<'a>);

#[derive(Copy, Clone)]
pub struct CopyType;

#[derive(Dependant)]
#[allow(dead_code)]
pub struct StructWithCopy<'a> {
    #[zc(check = "Copy")]
    field_a: &'a CopyType,
    field_b: (),
}

#[derive(Dependant)]
#[allow(dead_code)]
#[zc(check = "Copy")]
pub struct StructWithAllCopy<'a> {
    field_a: &'a CopyType,
    field_b: (),
}

#[derive(Dependant)]
#[allow(dead_code)]
pub struct StructWithDefault<'a> {
    #[zc(guard = "Default")]
    field: &'a (),
}

#[derive(PartialEq, Debug, Dependant)]
pub struct StructWithBytes<'a>(&'a [u8]);

impl<'a> From<&'a [u8]> for StructWithBytes<'a> {
    fn from(bytes: &'a [u8]) -> Self {
        Self(&bytes[1..])
    }
}

fn construct_struct_with_bytes(bytes: &[u8]) -> StructWithBytes<'_> {
    StructWithBytes(&bytes[1..])
}

#[test]
fn test_struct_with_bytes_construct() {
    let owner = vec![1, 2, 3];
    let data = Zc::new(owner, construct_struct_with_bytes);

    assert_eq!(data.get::<StructWithBytes>(), &StructWithBytes(&[2, 3]));
}

#[test]
fn test_struct_with_bytes_from() {
    let owner = vec![1, 2, 3];
    let data = zc::from!(owner, StructWithBytes, [u8]);

    assert_eq!(data.get::<StructWithBytes>(), &StructWithBytes(&[2, 3]));

    assert_eq!(
        format!("{:?}", data),
        "Zc { storage: [1, 2, 3], value: StructWithBytes([2, 3]) }"
    );
}

#[test]
fn test_struct_with_bytes_try_from() {
    let owner = vec![1, 2, 3];
    let data = zc::try_from!(owner, StructWithBytes, [u8]).unwrap();

    assert_eq!(data.get::<StructWithBytes>(), &StructWithBytes(&[2, 3]));
}

#[test]
fn test_struct_with_str_from() {
    #[derive(PartialEq, Debug, Dependant)]
    pub struct StructWithStr<'a>(&'a str);

    impl<'a> From<&'a str> for StructWithStr<'a> {
        fn from(s: &'a str) -> Self {
            Self(&s[1..])
        }
    }

    let owner = String::from("hello");
    let data = zc::from!(owner, StructWithStr, str);

    assert_eq!(data.get::<StructWithStr>(), &StructWithStr("ello"));
}

#[test]
fn test_struct_with_error() {
    #[derive(PartialEq, Debug, Dependant)]
    pub struct StructWithError<'a>(&'a str);

    impl<'a> core::convert::TryFrom<&'a str> for StructWithError<'a> {
        type Error = ();

        fn try_from(_: &'a str) -> Result<Self, Self::Error> {
            Err(())
        }
    }

    let owner = String::from("hello");
    let result = zc::try_from!(owner, StructWithError, str);

    assert_eq!(result.unwrap_err(), ((), String::from("hello")));
}

#[test]
fn test_aliasable_box() {
    #[derive(PartialEq, Debug, Dependant)]
    pub struct StructWithBoxRef<'a>(&'a u8);

    impl<'a> From<&'a u8> for StructWithBoxRef<'a> {
        fn from(v: &'a u8) -> Self {
            Self(v)
        }
    }

    let owner = AliasableBox::from(Box::new(1u8));
    let data = zc::from!(owner, StructWithBoxRef, u8);

    assert_eq!(data.get::<StructWithBoxRef>(), &StructWithBoxRef(&1));
    assert_eq!(AliasableBox::into_unique(data.into_owner()), Box::new(1));
}

#[test]
fn test_aliasable_vec() {
    #[derive(PartialEq, Debug, Dependant)]
    pub struct StructWithVecRef<'a>(&'a [u8]);

    impl<'a> From<&'a [u8]> for StructWithVecRef<'a> {
        fn from(v: &'a [u8]) -> Self {
            Self(v)
        }
    }

    let owner = AliasableVec::from(vec![1u8]);
    let data = zc::from!(owner, StructWithVecRef, [u8]);

    assert_eq!(data.get::<StructWithVecRef>(), &StructWithVecRef(&[1u8]));
    assert_eq!(AliasableVec::into_unique(data.into_owner()), vec![1]);
}