zyxdb-sys 0.1.28

Raw Driver ABI bindings for the ZYX embedded graph database
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
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
#![allow(non_camel_case_types)]
#![allow(non_snake_case)]
#![allow(non_upper_case_globals)]

use std::ffi::c_char;
use std::os::raw::{c_double, c_int};

#[repr(C)]
pub struct zyx_driver_db_t {
    _private: [u8; 0],
}

#[repr(C)]
pub struct zyx_driver_txn_t {
    _private: [u8; 0],
}

#[repr(C)]
pub struct zyx_driver_result_t {
    _private: [u8; 0],
}

#[repr(C)]
pub struct zyx_driver_params_t {
    _private: [u8; 0],
}

#[repr(C)]
pub struct zyx_driver_value_t {
    _private: [u8; 0],
}

#[repr(C)]
pub struct zyx_driver_ingest_t {
    _private: [u8; 0],
}

#[repr(C)]
pub struct zyx_driver_edge_ingestor_t {
    _private: [u8; 0],
}

#[repr(C)]
pub struct zyx_driver_error_t {
    _private: [u8; 0],
}

pub type zyx_driver_status_t = c_int;

pub const ZYX_DRIVER_OK: zyx_driver_status_t = 0;
pub const ZYX_DRIVER_ROW: zyx_driver_status_t = 1;
pub const ZYX_DRIVER_DONE: zyx_driver_status_t = 2;
pub const ZYX_DRIVER_INVALID_ARGUMENT: zyx_driver_status_t = 100;
pub const ZYX_DRIVER_NOT_FOUND: zyx_driver_status_t = 101;
pub const ZYX_DRIVER_OPEN_FAILED: zyx_driver_status_t = 102;
pub const ZYX_DRIVER_PARSE_ERROR: zyx_driver_status_t = 200;
pub const ZYX_DRIVER_EXECUTION_ERROR: zyx_driver_status_t = 201;
pub const ZYX_DRIVER_TRANSACTION_ERROR: zyx_driver_status_t = 300;
pub const ZYX_DRIVER_READ_ONLY_VIOLATION: zyx_driver_status_t = 301;
pub const ZYX_DRIVER_TYPE_MISMATCH: zyx_driver_status_t = 400;
pub const ZYX_DRIVER_OUT_OF_RANGE: zyx_driver_status_t = 401;
pub const ZYX_DRIVER_IO_ERROR: zyx_driver_status_t = 500;
pub const ZYX_DRIVER_OUT_OF_MEMORY: zyx_driver_status_t = 600;
pub const ZYX_DRIVER_INTERNAL_ERROR: zyx_driver_status_t = 900;

pub type zyx_driver_value_type_t = c_int;

pub const ZYX_DRIVER_VALUE_NULL: zyx_driver_value_type_t = 0;
pub const ZYX_DRIVER_VALUE_BOOL: zyx_driver_value_type_t = 1;
pub const ZYX_DRIVER_VALUE_INT64: zyx_driver_value_type_t = 2;
pub const ZYX_DRIVER_VALUE_DOUBLE: zyx_driver_value_type_t = 3;
pub const ZYX_DRIVER_VALUE_STRING: zyx_driver_value_type_t = 4;
pub const ZYX_DRIVER_VALUE_NODE: zyx_driver_value_type_t = 5;
pub const ZYX_DRIVER_VALUE_EDGE: zyx_driver_value_type_t = 6;
pub const ZYX_DRIVER_VALUE_LIST: zyx_driver_value_type_t = 7;
pub const ZYX_DRIVER_VALUE_MAP: zyx_driver_value_type_t = 8;

#[repr(C)]
#[derive(Debug, Copy, Clone)]
pub struct zyx_driver_value_ref_t {
    pub owner_id: u64,
    pub owner_cookie: u64,
    pub generation: u64,
    pub slot: u64,
}

#[repr(C)]
#[derive(Debug, Copy, Clone)]
pub struct zyx_driver_id_range_t {
    pub first_id: i64,
    pub count: i64,
}

#[repr(C)]
pub struct ArrowSchema {
    pub format: *const c_char,
    pub name: *const c_char,
    pub metadata: *const c_char,
    pub flags: i64,
    pub n_children: i64,
    pub children: *mut *mut ArrowSchema,
    pub dictionary: *mut ArrowSchema,
    pub release: Option<unsafe extern "C" fn(*mut ArrowSchema)>,
    pub private_data: *mut std::ffi::c_void,
}

#[repr(C)]
pub struct ArrowArray {
    pub length: i64,
    pub null_count: i64,
    pub offset: i64,
    pub n_buffers: i64,
    pub n_children: i64,
    pub buffers: *mut *const std::ffi::c_void,
    pub children: *mut *mut ArrowArray,
    pub dictionary: *mut ArrowArray,
    pub release: Option<unsafe extern "C" fn(*mut ArrowArray)>,
    pub private_data: *mut std::ffi::c_void,
}

extern "C" {
    pub fn zyx_driver_abi_version_major() -> u32;
    pub fn zyx_driver_abi_version_minor() -> u32;
    pub fn zyx_driver_abi_version_patch() -> u32;
    pub fn zyx_driver_runtime_version() -> *const c_char;

    pub fn zyx_driver_error_code(error: *const zyx_driver_error_t) -> zyx_driver_status_t;
    pub fn zyx_driver_error_message(error: *const zyx_driver_error_t) -> *const c_char;
    pub fn zyx_driver_error_row_index(error: *const zyx_driver_error_t) -> i64;
    pub fn zyx_driver_error_field_path(error: *const zyx_driver_error_t) -> *const c_char;
    pub fn zyx_driver_error_free(error: *mut zyx_driver_error_t);

    pub fn zyx_driver_db_open(
        path: *const c_char,
        out_db: *mut *mut zyx_driver_db_t,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_db_open_if_exists(
        path: *const c_char,
        out_db: *mut *mut zyx_driver_db_t,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_db_close(
        db: *mut zyx_driver_db_t,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_db_save(
        db: *mut zyx_driver_db_t,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_db_has_active_transaction(
        db: *mut zyx_driver_db_t,
        out_value: *mut bool,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_db_set_thread_pool_size(
        db: *mut zyx_driver_db_t,
        size: u32,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;

    pub fn zyx_driver_ingest_begin(
        db: *mut zyx_driver_db_t,
        out_ingest: *mut *mut zyx_driver_ingest_t,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_ingest_prepare_edges(
        ingest: *mut zyx_driver_ingest_t,
        edge_type: *const c_char,
        schema: *const ArrowSchema,
        out_ingestor: *mut *mut zyx_driver_edge_ingestor_t,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_edge_ingestor_write(
        ingestor: *mut zyx_driver_edge_ingestor_t,
        record_batch: *const ArrowArray,
        out_ids: *mut zyx_driver_id_range_t,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_ingest_commit(
        ingest: *mut zyx_driver_ingest_t,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_ingest_rollback(
        ingest: *mut zyx_driver_ingest_t,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_edge_ingestor_close(
        ingestor: *mut zyx_driver_edge_ingestor_t,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_ingest_close(
        ingest: *mut zyx_driver_ingest_t,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;

    pub fn zyx_driver_txn_begin(
        db: *mut zyx_driver_db_t,
        out_txn: *mut *mut zyx_driver_txn_t,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_txn_begin_read_only(
        db: *mut zyx_driver_db_t,
        out_txn: *mut *mut zyx_driver_txn_t,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_txn_execute(
        txn: *mut zyx_driver_txn_t,
        cypher: *const c_char,
        params: *const zyx_driver_params_t,
        out_result: *mut *mut zyx_driver_result_t,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_txn_commit(
        txn: *mut zyx_driver_txn_t,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_txn_rollback(
        txn: *mut zyx_driver_txn_t,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_txn_close(
        txn: *mut zyx_driver_txn_t,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;

    pub fn zyx_driver_params_create(
        out_params: *mut *mut zyx_driver_params_t,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_params_free(
        params: *mut zyx_driver_params_t,
        out_error: *mut *mut zyx_driver_error_t,
    );
    pub fn zyx_driver_params_set_null(
        params: *mut zyx_driver_params_t,
        key: *const c_char,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_params_set_bool(
        params: *mut zyx_driver_params_t,
        key: *const c_char,
        value: bool,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_params_set_int64(
        params: *mut zyx_driver_params_t,
        key: *const c_char,
        value: i64,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_params_set_double(
        params: *mut zyx_driver_params_t,
        key: *const c_char,
        value: c_double,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_params_set_string(
        params: *mut zyx_driver_params_t,
        key: *const c_char,
        value: *const c_char,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_params_set_string_list(
        params: *mut zyx_driver_params_t,
        key: *const c_char,
        values: *const *const c_char,
        count: u32,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_params_set_float_list(
        params: *mut zyx_driver_params_t,
        key: *const c_char,
        values: *const f32,
        count: u32,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_params_set_value(
        params: *mut zyx_driver_params_t,
        key: *const c_char,
        value: *const zyx_driver_value_t,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;

    pub fn zyx_driver_value_null_create(
        out_value: *mut *mut zyx_driver_value_t,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_value_bool_create(
        value: bool,
        out_value: *mut *mut zyx_driver_value_t,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_value_int64_create(
        value: i64,
        out_value: *mut *mut zyx_driver_value_t,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_value_double_create(
        value: c_double,
        out_value: *mut *mut zyx_driver_value_t,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_value_string_create(
        value: *const c_char,
        out_value: *mut *mut zyx_driver_value_t,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_value_list_create(
        out_value: *mut *mut zyx_driver_value_t,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_value_map_create(
        out_value: *mut *mut zyx_driver_value_t,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_value_free(
        value: *mut zyx_driver_value_t,
        out_error: *mut *mut zyx_driver_error_t,
    );

    pub fn zyx_driver_value_list_append_null(
        list: *mut zyx_driver_value_t,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_value_list_append_bool(
        list: *mut zyx_driver_value_t,
        value: bool,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_value_list_append_int64(
        list: *mut zyx_driver_value_t,
        value: i64,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_value_list_append_double(
        list: *mut zyx_driver_value_t,
        value: c_double,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_value_list_append_string(
        list: *mut zyx_driver_value_t,
        value: *const c_char,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_value_list_append_value(
        list: *mut zyx_driver_value_t,
        value: *const zyx_driver_value_t,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;

    pub fn zyx_driver_value_map_set_null(
        map: *mut zyx_driver_value_t,
        key: *const c_char,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_value_map_set_bool(
        map: *mut zyx_driver_value_t,
        key: *const c_char,
        value: bool,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_value_map_set_int64(
        map: *mut zyx_driver_value_t,
        key: *const c_char,
        value: i64,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_value_map_set_double(
        map: *mut zyx_driver_value_t,
        key: *const c_char,
        value: c_double,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_value_map_set_string(
        map: *mut zyx_driver_value_t,
        key: *const c_char,
        value: *const c_char,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_value_map_set_value(
        map: *mut zyx_driver_value_t,
        key: *const c_char,
        value: *const zyx_driver_value_t,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;

    pub fn zyx_driver_db_create_node(
        db: *mut zyx_driver_db_t,
        label: *const c_char,
        properties: *const zyx_driver_params_t,
        out_node_id: *mut i64,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_db_create_node_with_labels(
        db: *mut zyx_driver_db_t,
        labels: *const *const c_char,
        label_count: u32,
        properties: *const zyx_driver_params_t,
        out_node_id: *mut i64,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_db_create_edge(
        db: *mut zyx_driver_db_t,
        source_id: i64,
        target_id: i64,
        edge_type: *const c_char,
        properties: *const zyx_driver_params_t,
        out_edge_id: *mut i64,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;

    pub fn zyx_driver_db_execute(
        db: *mut zyx_driver_db_t,
        cypher: *const c_char,
        params: *mut zyx_driver_params_t,
        out_result: *mut *mut zyx_driver_result_t,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_result_free(result: *mut zyx_driver_result_t);
    pub fn zyx_driver_result_next(
        result: *mut zyx_driver_result_t,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_result_column_count(result: *const zyx_driver_result_t) -> u32;
    pub fn zyx_driver_result_column_name(
        result: *mut zyx_driver_result_t,
        column: u32,
    ) -> *const c_char;
    pub fn zyx_driver_result_value_type(
        result: *const zyx_driver_result_t,
        column: u32,
    ) -> zyx_driver_value_type_t;
    pub fn zyx_driver_result_get_int64(
        result: *const zyx_driver_result_t,
        column: u32,
        out_value: *mut i64,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_result_get_double(
        result: *const zyx_driver_result_t,
        column: u32,
        out_value: *mut c_double,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_result_get_bool(
        result: *const zyx_driver_result_t,
        column: u32,
        out_value: *mut bool,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_result_get_string(
        result: *mut zyx_driver_result_t,
        column: u32,
        out_value: *mut *const c_char,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_result_get_list_count(
        result: *const zyx_driver_result_t,
        column: u32,
        out_value: *mut u32,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_result_get_list_value_type(
        result: *const zyx_driver_result_t,
        column: u32,
        index: u32,
    ) -> zyx_driver_value_type_t;
    pub fn zyx_driver_result_get_list_int64(
        result: *const zyx_driver_result_t,
        column: u32,
        index: u32,
        out_value: *mut i64,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_result_get_list_double(
        result: *const zyx_driver_result_t,
        column: u32,
        index: u32,
        out_value: *mut c_double,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_result_get_list_bool(
        result: *const zyx_driver_result_t,
        column: u32,
        index: u32,
        out_value: *mut bool,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_result_get_list_string(
        result: *mut zyx_driver_result_t,
        column: u32,
        index: u32,
        out_value: *mut *const c_char,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_result_get_value(
        result: *const zyx_driver_result_t,
        column: u32,
        out_value: *mut zyx_driver_value_ref_t,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_value_ref_type(
        value: *const zyx_driver_value_ref_t,
    ) -> zyx_driver_value_type_t;
    pub fn zyx_driver_value_ref_get_int64(
        value: *const zyx_driver_value_ref_t,
        out_value: *mut i64,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_value_ref_get_double(
        value: *const zyx_driver_value_ref_t,
        out_value: *mut c_double,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_value_ref_get_bool(
        value: *const zyx_driver_value_ref_t,
        out_value: *mut bool,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_value_ref_get_string(
        result: *mut zyx_driver_result_t,
        value: *const zyx_driver_value_ref_t,
        out_value: *mut *const c_char,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_value_ref_list_count(
        value: *const zyx_driver_value_ref_t,
        out_value: *mut u32,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_value_ref_list_get(
        value: *const zyx_driver_value_ref_t,
        index: u32,
        out_value: *mut zyx_driver_value_ref_t,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_value_ref_list_get_int64(
        value: *const zyx_driver_value_ref_t,
        index: u32,
        out_value: *mut i64,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_value_ref_list_get_double(
        value: *const zyx_driver_value_ref_t,
        index: u32,
        out_value: *mut c_double,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_value_ref_list_get_bool(
        value: *const zyx_driver_value_ref_t,
        index: u32,
        out_value: *mut bool,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_value_ref_list_get_string(
        result: *mut zyx_driver_result_t,
        value: *const zyx_driver_value_ref_t,
        index: u32,
        out_value: *mut *const c_char,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_value_ref_map_count(
        value: *const zyx_driver_value_ref_t,
        out_value: *mut u32,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_value_ref_map_key(
        result: *mut zyx_driver_result_t,
        value: *const zyx_driver_value_ref_t,
        index: u32,
        out_key: *mut *const c_char,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_value_ref_map_get(
        value: *const zyx_driver_value_ref_t,
        key: *const c_char,
        out_value: *mut zyx_driver_value_ref_t,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_value_ref_map_get_int64(
        value: *const zyx_driver_value_ref_t,
        key: *const c_char,
        out_value: *mut i64,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_value_ref_map_get_double(
        value: *const zyx_driver_value_ref_t,
        key: *const c_char,
        out_value: *mut c_double,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_value_ref_map_get_bool(
        value: *const zyx_driver_value_ref_t,
        key: *const c_char,
        out_value: *mut bool,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_value_ref_map_get_string(
        result: *mut zyx_driver_result_t,
        value: *const zyx_driver_value_ref_t,
        key: *const c_char,
        out_value: *mut *const c_char,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_value_ref_get_node_id(
        value: *const zyx_driver_value_ref_t,
        out_value: *mut i64,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_value_ref_get_node_label_count(
        value: *const zyx_driver_value_ref_t,
        out_value: *mut u32,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_value_ref_get_node_label(
        result: *mut zyx_driver_result_t,
        value: *const zyx_driver_value_ref_t,
        label_index: u32,
        out_value: *mut *const c_char,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_value_ref_get_edge_id(
        value: *const zyx_driver_value_ref_t,
        out_value: *mut i64,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_value_ref_get_edge_source_id(
        value: *const zyx_driver_value_ref_t,
        out_value: *mut i64,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_value_ref_get_edge_target_id(
        value: *const zyx_driver_value_ref_t,
        out_value: *mut i64,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_value_ref_get_edge_type(
        result: *mut zyx_driver_result_t,
        value: *const zyx_driver_value_ref_t,
        out_value: *mut *const c_char,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_value_ref_get_entity_properties_json(
        result: *mut zyx_driver_result_t,
        value: *const zyx_driver_value_ref_t,
        out_value: *mut *const c_char,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_result_get_node_id(
        result: *const zyx_driver_result_t,
        column: u32,
        out_value: *mut i64,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_result_get_node_label_count(
        result: *const zyx_driver_result_t,
        column: u32,
        out_value: *mut u32,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_result_get_node_label(
        result: *mut zyx_driver_result_t,
        column: u32,
        label_index: u32,
        out_value: *mut *const c_char,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_result_get_edge_id(
        result: *const zyx_driver_result_t,
        column: u32,
        out_value: *mut i64,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_result_get_edge_source_id(
        result: *const zyx_driver_result_t,
        column: u32,
        out_value: *mut i64,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_result_get_edge_target_id(
        result: *const zyx_driver_result_t,
        column: u32,
        out_value: *mut i64,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_result_get_edge_type(
        result: *mut zyx_driver_result_t,
        column: u32,
        out_value: *mut *const c_char,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
    pub fn zyx_driver_result_get_entity_properties_json(
        result: *mut zyx_driver_result_t,
        column: u32,
        out_value: *mut *const c_char,
        out_error: *mut *mut zyx_driver_error_t,
    ) -> zyx_driver_status_t;
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::mem::{align_of, size_of};

    #[test]
    fn value_ref_layout_matches_four_u64_tokens() {
        assert_eq!(size_of::<zyx_driver_value_ref_t>(), 4 * size_of::<u64>());
        assert_eq!(align_of::<zyx_driver_value_ref_t>(), align_of::<u64>());
    }

    #[test]
    fn value_ref_supports_copy_clone_and_debug() {
        let value_ref = zyx_driver_value_ref_t {
            owner_id: 1,
            owner_cookie: 2,
            generation: 3,
            slot: 4,
        };

        let copied = value_ref;
        let cloned = value_ref.clone();
        let debug = format!("{:?}", value_ref);

        assert_eq!(copied.owner_id, 1);
        assert_eq!(copied.owner_cookie, 2);
        assert_eq!(cloned.generation, 3);
        assert_eq!(cloned.slot, 4);
        assert!(debug.contains("zyx_driver_value_ref_t"));
    }
}