tugraph 0.1.4

A rust binding for the TuGraph library
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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
// Copyright 2023 antkiller
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#![allow(unused)]

macro_rules! raw_core_cursor_rustlize {
    (
        $cursor_name:ident,
        $cursor_ctype:ident,
        $cursor_close:ident,
        $cursor_destroy:ident,
        $cursor_is_valid:ident,
        $cursor_next:ident$(,)?
    ) => {
        /// RAIIize the unsafe c bindings and Rustlize all types cross api boundary.
        pub(crate) struct $cursor_name {
            inner: *mut $crate::ffi::$cursor_ctype,
        }

        impl Drop for $cursor_name {
            fn drop(&mut self) {
                unsafe {
                    $crate::ffi::$cursor_close(self.inner);
                    $crate::ffi::$cursor_destroy(self.inner);
                }
            }
        }

        impl $cursor_name {
            ///
            ///
            /// # Safety
            ///
            /// The `ptr` passed in must be a valid and non-null pointer
            /// created by libtugraph_sys::lgraph_api_transaction_get_vertex_iterator or
            /// libtugraph_sys::lgraph_api_vertex_iterator_get_out_edge_iterator and their
            /// variants
            pub(crate) unsafe fn from_ptr(ptr: *mut $crate::ffi::$cursor_ctype) -> Self {
                $cursor_name { inner: ptr }
            }
            pub(crate) fn is_valid(&self) -> bool {
                unsafe { $crate::ffi::$cursor_is_valid(self.inner) }
            }

            pub(crate) fn next(&self) -> $crate::Result<bool> {
                unsafe {
                    ffi_try! {$crate::ffi::$cursor_next(self.inner)}
                }
            }
        }
    };
}

macro_rules! raw_core_cursor_primary_ext_rustlize {
    (
        $cursor_name:ident,
        $cursor_get_label_id:ident
        $(
        ,
        $cursor_get_label:ident,
        $cursor_get_fields_by_names:ident,
        $cursor_get_field_by_name:ident,
        $cursor_get_fields_by_ids:ident,
        $cursor_get_field_by_id:ident,
        $cursor_get_all_fields:ident,
        $cursor_set_field_by_name:ident,
        $cursor_set_field_by_id:ident,
        $cursor_set_fields_by_value_strings:ident,
        $cursor_set_fields_by_data:ident,
        $cursor_set_fields_by_ids:ident
        )?
        $(,)?
    ) => {
        impl $cursor_name {
            pub(crate) fn get_label_id(&self) -> $crate::Result<u16> {
                unsafe {
                    ffi_try! { $crate::ffi::$cursor_get_label_id(self.inner) }
                }
            }

            $(
            pub(crate) fn get_label(&self) -> $crate::Result<String> {
                unsafe {
                    ffi_try! { $crate::ffi::$cursor_get_label(self.inner) }
                        .map(|l| $crate::raw::ffi_util::from_cstr(l))
                }
            }

            pub(crate) fn get_fields_by_names<T: $crate::raw::ffi_util::CStrLike + Copy>(
                &self,
                names: &[T],
            ) -> $crate::Result<Vec<super::RawFieldData>> {
                unsafe {
                    let cnames: Vec<_> = names
                        .iter()
                        .map(|cstr| cstr.into_c_string().unwrap())
                        .collect();
                    let cnames: Vec<*const libc::c_char> =
                        cnames.iter().map(|v| v.as_ptr()).collect();
                    let mut cfield_datas: *mut *mut $crate::ffi::lgraph_api_field_data_t =
                        std::ptr::null_mut();
                    let len = ffi_try! {
                        $crate::ffi::$cursor_get_fields_by_names(
                            self.inner,
                            cnames.as_ptr(),
                            cnames.len(),
                            &mut cfield_datas as *mut _,
                        )
                    }?;
                    let field_datas: Vec<_> = std::slice::from_raw_parts(cfield_datas, len)
                        .iter()
                        .map(|ptr| super::RawFieldData::from_ptr(*ptr))
                        .collect();
                    Ok(field_datas)
                }
            }

            pub(crate) fn get_field_by_name<T: $crate::raw::ffi_util::CStrLike>(
                &self,
                name: T,
            ) -> $crate::Result<super::RawFieldData> {
                unsafe {
                    let cname = name.into_c_string().unwrap();
                    ffi_try! {
                        $crate::ffi::$cursor_get_field_by_name(self.inner, cname.as_ptr())
                    }
                    .map(|ptr| unsafe { super::RawFieldData::from_ptr(ptr) })
                }
            }

            pub(crate) fn get_fields_by_ids(
                &self,
                ids: &[usize],
            ) -> $crate::Result<Vec<super::RawFieldData>> {
                unsafe {
                    let mut cfield_datas: *mut *mut $crate::ffi::lgraph_api_field_data_t =
                        std::ptr::null_mut();
                    let len = ffi_try! {
                        $crate::ffi::$cursor_get_fields_by_ids(
                            self.inner,
                            ids.as_ptr(),
                            ids.len(),
                            &mut cfield_datas as *mut _,
                        )
                    }?;
                    let field_datas: Vec<_> = std::slice::from_raw_parts(cfield_datas, len)
                        .iter()
                        .map(|ptr| super::RawFieldData::from_ptr(*ptr))
                        .collect();
                    Ok(field_datas)
                }
            }

            pub(crate) fn get_field_by_id(
                &self,
                id: usize,
            ) -> $crate::Result<super::RawFieldData> {
                unsafe {
                    ffi_try! {
                        $crate::ffi::$cursor_get_field_by_id(self.inner, id)
                    }
                    .map(|ptr| unsafe { super::RawFieldData::from_ptr(ptr) })
                }
            }

            pub(crate) fn get_all_fields(
                &self,
            ) -> $crate::Result<(Vec<String>, Vec<super::RawFieldData>)> {
                unsafe {
                    let mut cfield_names: *mut *mut libc::c_char = std::ptr::null_mut();
                    let mut cfield_datas: *mut *mut $crate::ffi::lgraph_api_field_data_t =
                        std::ptr::null_mut();

                    let len = ffi_try! {
                        $crate::ffi::$cursor_get_all_fields(
                            self.inner,
                            &mut cfield_names as *mut _,
                            &mut cfield_datas as *mut _,
                        )
                    }?;
                    let names: Vec<_> = std::slice::from_raw_parts(cfield_names, len)
                        .iter()
                        .map(|ptr| $crate::raw::ffi_util::from_cstr(*ptr))
                        .collect();
                    let field_datas: Vec<_> = std::slice::from_raw_parts(cfield_datas, len)
                        .iter()
                        .map(|ptr| super::RawFieldData::from_ptr(*ptr))
                        .collect();
                    $crate::ffi::lgraph_api_field_names_destroy(cfield_names, len);
                    Ok((
                        names,
                        field_datas,
                    ))
                }
            }

            pub(crate) fn set_field_by_name<T: $crate::raw::ffi_util::CStrLike>(
                &self,
                name: T,
                data: &super::RawFieldData,
            ) -> $crate::Result<()> {
                unsafe {
                    let cname = name.into_c_string().unwrap();
                    ffi_try! {
                        $crate::ffi::$cursor_set_field_by_name(
                            self.inner,
                            cname.as_ptr(),
                            data.as_ptr(),
                        )
                    }
                }
            }

            pub(crate) fn set_field_by_id(
                &self,
                id: usize,
                data: &super::RawFieldData,
            ) -> $crate::Result<()> {
                unsafe {
                    ffi_try! {
                        $crate::ffi::$cursor_set_field_by_id(
                            self.inner,
                            id,
                            data.as_ptr(),
                        )
                    }
                }
            }

            pub(crate) fn set_fields_by_value_strings<T: $crate::raw::ffi_util::CStrLike + Copy>(
                &self,
                names: &[T],
                value_strings: &[T],
            ) -> $crate::Result<()> {
                unsafe {
                    let cnames: Vec<_> = names
                        .iter()
                        .map(|cstr| cstr.into_c_string().unwrap())
                        .collect();
                    let cnames: Vec<*const libc::c_char> =
                        cnames.iter().map(|v| v.as_ptr()).collect();
                    let cvalue_strings: Vec<_> = value_strings
                        .iter()
                        .map(|cstr| cstr.into_c_string().unwrap())
                        .collect();
                    let cvalue_strings: Vec<*const libc::c_char> =
                        cvalue_strings.iter().map(|s| s.as_ptr()).collect();
                    ffi_try! {
                        $crate::ffi::$cursor_set_fields_by_value_strings(
                            self.inner,
                            cnames.as_ptr(),
                            cnames.len(),
                            cvalue_strings.as_ptr(),
                            cvalue_strings.len(),
                        )
                    }
                }
            }

            pub(crate) fn set_fields_by_data<'a, T, N, V>(
                &self,
                names: N,
                values: V,
            ) -> $crate::Result<()>
            where
                T: $crate::raw::ffi_util::CStrLike + Copy,
                N: std::iter::IntoIterator<Item = T>,
                V: std::iter::IntoIterator<Item = &'a super::RawFieldData>,
            {
                unsafe {
                    let cnames: Vec<_> = names
                        .into_iter()
                        .map(|cstr| cstr.into_c_string().unwrap())
                        .collect();
                    let cnames: Vec<*const libc::c_char> =
                        cnames.iter().map(|n| n.as_ptr()).collect();
                    let cfield_values: Vec<_> = values.into_iter().map(|s| s.as_ptr()).collect();
                    ffi_try! {
                        $crate::ffi::$cursor_set_fields_by_data(
                            self.inner,
                            cnames.as_ptr(),
                            cnames.len(),
                            cfield_values.as_ptr(),
                            cfield_values.len(),
                        )
                    }
                }
            }

            pub(crate) fn set_fields_by_ids<'a, T>(
                &self,
                ids: &[usize],
                values: T,
            ) -> $crate::Result<()>
            where
                T: std::iter::IntoIterator<Item = &'a super::RawFieldData>
            {
                unsafe {
                    let cfield_values: Vec<_> = values.into_iter().map(|s| s.as_ptr()).collect();
                    ffi_try! {
                        $crate::ffi::$cursor_set_fields_by_ids(
                            self.inner,
                            ids.as_ptr(),
                            ids.len(),
                            cfield_values.as_ptr(),
                            cfield_values.len(),
                        )
                    }
                }
            }
            )?
        }
    };
}

macro_rules! raw_primary_cursor_rustlize {
    (
        $cursor_name:ident,
        $cursor_ctype:ident,
        $cursor_close:ident,
        $cursor_destroy:ident,
        $cursor_is_valid:ident,
        $cursor_next:ident,
        $cursor_get_label:ident,
        $cursor_get_label_id:ident,
        $cursor_get_fields_by_names:ident,
        $cursor_get_field_by_name:ident,
        $cursor_get_fields_by_ids:ident,
        $cursor_get_field_by_id:ident,
        $cursor_get_all_fields:ident,
        $cursor_set_field_by_name:ident,
        $cursor_set_field_by_id:ident,
        $cursor_set_fields_by_value_strings:ident,
        $cursor_set_fields_by_data:ident,
        $cursor_set_fields_by_ids:ident$(,)?
    ) => {
        raw_core_cursor_rustlize!(
            $cursor_name,
            $cursor_ctype,
            $cursor_close,
            $cursor_destroy,
            $cursor_is_valid,
            $cursor_next,
        );

        raw_core_cursor_primary_ext_rustlize!(
            $cursor_name,
            $cursor_get_label_id,
            $cursor_get_label,
            $cursor_get_fields_by_names,
            $cursor_get_field_by_name,
            $cursor_get_fields_by_ids,
            $cursor_get_field_by_id,
            $cursor_get_all_fields,
            $cursor_set_field_by_name,
            $cursor_set_field_by_id,
            $cursor_set_fields_by_value_strings,
            $cursor_set_fields_by_data,
            $cursor_set_fields_by_ids,
        );
    };
}

macro_rules! raw_pod_rustlize {
    (
        $pod_name:ident,
        $pod_ctype:ident,
        $pod_destroy:ident$(,)?
    ) => {
        pub(crate) struct $pod_name {
            inner: *mut $crate::ffi::$pod_ctype,
        }

        impl $pod_name {
            ///
            /// # Safety
            ///
            /// The `ptr` passed in must be valid and non-null
            /// created by libtugraph_sys::lgraph_api_{TYPE}_create or libtugraph_sys::lgraph_api_{CLASS}_get_{TYPE}
            /// where {CLASS} is a name of class and {TYPE} is a name of this type
            pub(crate) unsafe fn from_ptr(ptr: *mut $crate::ffi::$pod_ctype) -> Self {
                $pod_name { inner: ptr }
            }

            pub(crate) fn as_ptr(&self) -> *const $crate::ffi::$pod_ctype {
                self.inner
            }
            pub(crate) fn into_ptr(self) -> *mut $crate::ffi::$pod_ctype {
                self.inner
            }

            pub(crate) unsafe fn as_ptr_mut(&self) -> *mut $crate::ffi::$pod_ctype {
                self.inner
            }
        }

        impl Drop for $pod_name {
            fn drop(&mut self) {
                unsafe {
                    $crate::ffi::$pod_destroy(self.inner);
                }
            }
        }
    };
}

#[macro_use]
mod ffi_util;
mod db;
mod edge;
mod field_data;
mod field_spec;
mod galaxy;
mod index_spec;
mod role_info;
mod txn;
mod types;
mod user_info;
mod vertex;

pub(crate) use db::RawGraphDB;
pub(crate) use edge::{RawEdgeCursor, RawEdgeIndexIterator, RawInEdgeCursor, RawOutEdgeCursor};
pub(crate) use field_data::RawFieldData;
pub(crate) use field_spec::RawFieldSpec;
pub(crate) use galaxy::RawGalaxy;
pub(crate) use index_spec::RawIndexSpec;
pub(crate) use role_info::RawRoleInfo;
pub(crate) use txn::RawTransaction;
pub(crate) use types::{RawDate, RawDateTime, RawEdgeUid};
pub(crate) use user_info::RawUserInfo;
pub(crate) use vertex::{RawVertexCursor, RawVertexIndexIterator};