extendr-api 0.3.1

Safe and user friendly bindings to the R programming language.
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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174

#[cfg(feature = "serde")]
mod test {
    use extendr_api::deserializer::from_robj;
    use extendr_api::prelude::*;
    use serde::Deserialize;

    ////////////////////////////////////////////////////////////////////////////////
    ///
    /// Deserialize from a Robj.
    ///
    /// Like JSON, we can use a Robj as a storage format.
    ///
    /// For example if creating vectors from a RDS file or returning a structure
    /// or just doing a conversion.
    ///
    #[test]
    fn test_deserialize_robj() {
        test! {
            // In these tests, the wrapper is transparent and just tests the contents.
            // So Int(i32) is actually testing i32.

            #[derive(Deserialize, PartialEq, Debug)]
            struct Null;
            assert_eq!(from_robj::<Null>(&r!(NULL)), Ok(Null));
            assert_eq!(from_robj::<Null>(&r!(1)), Err(Error::ExpectedNull(r!(1))));

            #[derive(Deserialize, PartialEq, Debug)]
            struct Int(i32);
            assert_eq!(from_robj::<Int>(&r!(1)), Ok(Int(1)));
            assert_eq!(from_robj::<Int>(&r!(1.0)), Ok(Int(1)));
            assert_eq!(from_robj::<Int>(&r!(NULL)).is_err(), true);

            #[derive(Deserialize, PartialEq, Debug)]
            struct RInt(Rint);
            assert_eq!(from_robj::<RInt>(&r!(1)), Ok(RInt(1.into())));
            assert_eq!(from_robj::<RInt>(&r!(1.0)), Ok(RInt(1.into())));
            assert_eq!(from_robj::<RInt>(&r!(Rint::na())).is_err(), true);
            assert_eq!(from_robj::<RInt>(&r!(NULL)).is_err(), true);

            #[derive(Deserialize, PartialEq, Debug)]
            struct Float(f64);
            assert_eq!(from_robj::<Float>(&r!(1)), Ok(Float(1.0)));
            assert_eq!(from_robj::<Float>(&r!(1.0)), Ok(Float(1.0)));
            assert_eq!(from_robj::<Float>(&r!(NULL)).is_err(), true);

            #[derive(Deserialize, PartialEq, Debug)]
            struct RFloat(Rfloat);
            assert_eq!(from_robj::<RFloat>(&r!(1)), Ok(RFloat(1.0.into())));
            assert_eq!(from_robj::<RFloat>(&r!(1.0)), Ok(RFloat(1.0.into())));
            assert_eq!(from_robj::<RFloat>(&r!(Rfloat::na())).is_err(), true);
            assert_eq!(from_robj::<RFloat>(&r!(NULL)).is_err(), true);

            #[derive(Deserialize, PartialEq, Debug)]
            struct Bool(bool);
            assert_eq!(from_robj::<Bool>(&r!(TRUE)), Ok(Bool(true)));
            assert_eq!(from_robj::<Bool>(&r!(FALSE)), Ok(Bool(false)));
            assert_eq!(from_robj::<Bool>(&r!(NULL)).is_err(), true);

            #[derive(Deserialize, PartialEq, Debug)]
            struct RBool(Rbool);
            assert_eq!(from_robj::<RBool>(&r!(TRUE)), Ok(RBool(TRUE)));
            assert_eq!(from_robj::<RBool>(&r!(FALSE)), Ok(RBool(FALSE)));
            assert_eq!(from_robj::<RBool>(&r!(Rbool::na())).is_err(), true);
            assert_eq!(from_robj::<RBool>(&r!(NULL)).is_err(), true);

            #[derive(Deserialize, PartialEq, Debug)]
            struct VInt(Vec<i32>);
            assert_eq!(from_robj::<VInt>(&r!(list!(1, 2))), Ok(VInt(vec![1, 2])));
            assert_eq!(from_robj::<VInt>(&r!([1, 2])), Ok(VInt(vec![1, 2])));
            assert_eq!(from_robj::<VInt>(&r!([1, 2, i32::na()])).is_err(), true);

            // Any integer type will do.
            #[derive(Deserialize, PartialEq, Debug)]
            struct VInt16(Vec<i16>);
            assert_eq!(from_robj::<VInt16>(&r!(list!(1, 2))), Ok(VInt16(vec![1, 2])));
            assert_eq!(from_robj::<VInt16>(&r!([1, 2])), Ok(VInt16(vec![1, 2])));

            #[derive(Deserialize, PartialEq, Debug)]
            struct VFloat64(Vec<f64>);
            assert_eq!(from_robj::<VFloat64>(&r!(list!(1, 2))), Ok(VFloat64(vec![1., 2.])));
            assert_eq!(from_robj::<VFloat64>(&r!([1, 2])), Ok(VFloat64(vec![1., 2.])));

            #[derive(Deserialize, PartialEq, Debug)]
            struct VBool(Vec<bool>);
            assert_eq!(from_robj::<VBool>(&r!(list!(TRUE, FALSE))), Ok(VBool(vec![true, false])));
            assert_eq!(from_robj::<VBool>(&r!([TRUE, FALSE])), Ok(VBool(vec![true, false])));

            #[derive(Deserialize, PartialEq, Debug)]
            struct Str(String);
            assert_eq!(from_robj::<Str>(&r!("xyz")), Ok(Str("xyz".into())));

            #[derive(Deserialize, PartialEq, Debug)]
            struct StrSlice<'a>(&'a str);
            assert_eq!(from_robj::<StrSlice>(&r!("xyz")), Ok(StrSlice("xyz")));

            // Structs are mapped to named lists.
            #[derive(Deserialize, PartialEq, Debug)]
            struct Struct { a: i32, b: f64 }
            assert_eq!(from_robj::<Struct>(&r!(list!(a=1, b=2))), Ok(Struct{ a: 1, b: 2.0 }));

            // Enums are mapped to named lists of lists.
            #[derive(Deserialize, PartialEq, Debug)]
            enum Enum {
                Unit,
                Newtype(u32),
                Tuple(u32, u32),
                Struct { a: u32 },
            }

            let j = r!("Unit");
            let expected = Enum::Unit;
            assert_eq!(expected, from_robj(&j).unwrap());

            // If the name is wrong:
            let j = r!("UnitX");
            assert_eq!(from_robj::<Enum>(&j).is_err(), true);

            let j = r!(list!(Newtype=1));
            let expected = Enum::Newtype(1);
            assert_eq!(expected, from_robj(&j).unwrap());

            let j = r!(list!(Tuple=list!(1, 2)));
            let expected = Enum::Tuple(1, 2);
            assert_eq!(expected, from_robj(&j).unwrap());

            let j = r!(list!(Struct=list!(a=1)));
            let expected = Enum::Struct { a: 1 };
            assert_eq!(expected, from_robj(&j).unwrap());

            // Many things will generate a Robj.
            // But note that the original Robj will not be copied verbatim.
            // The Deserialize trait for Robj can also be used to generate
            // JSON and other formats for Robj.
            #[derive(Deserialize, PartialEq, Debug)]
            struct ROBJ(Robj);
            assert_eq!(from_robj::<ROBJ>(&r!(TRUE)), Ok(ROBJ(r!(TRUE))));
            assert_eq!(from_robj::<ROBJ>(&r!(1)), Ok(ROBJ(r!(1))));
            assert_eq!(from_robj::<ROBJ>(&r!(1.0)), Ok(ROBJ(r!(1.0))));
            assert_eq!(from_robj::<ROBJ>(&r!("xyz")), Ok(ROBJ(r!("xyz"))));

            // Sequences are always converted to lists.
            assert_eq!(from_robj::<ROBJ>(&r!([TRUE, FALSE])), Ok(ROBJ(r!(list!(TRUE, FALSE)))));
            assert_eq!(from_robj::<ROBJ>(&r!([1, 2])), Ok(ROBJ(r!(list!(1, 2)))));

            // If you use a wrapper type, conversions are more specific.
            #[derive(Deserialize, PartialEq, Debug)]
            struct RIntegers(Integers);
            assert_eq!(from_robj::<RIntegers>(&r!(1)), Ok(RIntegers(Integers::from_values([1]))));
            assert_eq!(from_robj::<RIntegers>(&r!([1, 2])), Ok(RIntegers(Integers::from_values([1, 2]))));
            assert_eq!(from_robj::<RIntegers>(&r!(1.0)).is_err(), true);
            assert_eq!(from_robj::<RIntegers>(&r!("xyz")).is_err(), true);

            #[derive(Deserialize, PartialEq, Debug)]
            struct RDoubles(Doubles);
            assert_eq!(from_robj::<RDoubles>(&r!(1)), Ok(RDoubles(Doubles::from_values([1.0]))));
            // assert_eq!(from_robj::<RDoubles>(&r!([1, 2])), Ok(RDoubles(Doubles::from_values([1.0, 2.0]))));
            assert_eq!(from_robj::<RDoubles>(&r!([1.0, 2.0])), Ok(RDoubles(Doubles::from_values([1.0, 2.0]))));
            assert_eq!(from_robj::<RDoubles>(&r!("xyz")).is_err(), true);

            #[derive(Deserialize, PartialEq, Debug)]
            struct RLogicals(Logicals);
            assert_eq!(from_robj::<RLogicals>(&r!(TRUE)), Ok(RLogicals(Logicals::from_values([TRUE]))));
            assert_eq!(from_robj::<RLogicals>(&r!([TRUE, FALSE, NA_LOGICAL])), Ok(RLogicals(Logicals::from_values([TRUE, FALSE, NA_LOGICAL]))));
            assert_eq!(from_robj::<RLogicals>(&r!("xyz")).is_err(), true);

            // This requires a PR that is not yet merged.
            // #[derive(Deserialize, PartialEq, Debug)]
            // struct RStrings(Strings);
            // assert_eq!(from_robj::<RStrings>(&r!("xyz")), Ok(RStrings(Strings::from_values(["xyz"]))));
            // assert_eq!(from_robj::<RStrings>(&r!(["a", "b"])), Ok(RStrings(Strings::from_values(["a", "b"]))));
            // assert_eq!(from_robj::<RStrings>(&r!(0)).is_err(), true);
        }
    }
}