ncbi-vdb-sys 0.1.7

FFI library for the NCBI VDB
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

use std::os::raw::{c_char, c_void};

use super::klib::{KDirectory, KNamelist};
use super::rc_t;

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

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

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

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

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

#[link(name = "ncbi-vdb")]
extern "C" {
    pub fn VDBManagerMakeRead(mgr: *mut *const VDBManager, dir: *mut KDirectory) -> rc_t;
    pub fn VDBManagerMakeSchema(mgr: *const VDBManager, schema: *mut *mut VSchema) -> rc_t;
    pub fn VDBManagerOpenDBRead(
        mgr: *const VDBManager,
        db: *mut *const VDatabase,
        schema: *mut VSchema,
        path: *const c_char,
        ...
    ) -> rc_t;
    pub fn VDBManagerOpenTableRead(
        mgr: *const VDBManager,
        tbl: *mut *const VTable,
        schema: *mut VSchema,
        path: *const c_char,
        ...
    ) -> rc_t;
    pub fn VDatabaseOpenTableRead(
        db: *const VDatabase,
        tbl: *mut *const VTable,
        name: *const c_char,
    ) -> rc_t;
    pub fn VTableCreateCachedCursorRead(
        tbl: *const VTable,
        cursor: *mut *const VCursor,
        capacity: usize,
    ) -> rc_t;
    pub fn VTableListCol(tbl: *const VTable, columns: *mut *mut KNamelist) -> rc_t;
    pub fn VCursorAddColumn(cursor: *const VCursor, idx: *mut u32, name: *const c_char) -> rc_t;
    pub fn VCursorOpen(cursor: *const VCursor) -> rc_t;
    pub fn VCursorIdRange(
        cursor: *const VCursor,
        idx: u32,
        first: *mut i64,
        count: *mut u64,
    ) -> rc_t;
    pub fn VCursorCellDataDirect(
        cursor: *const VCursor,
        row_id: i64,
        column_idx: u32,
        elem_bits: *mut u32,
        data: *mut *const c_void,
        bit_offset: *mut u32,
        row_len: *mut u32,
    ) -> rc_t;

    // Release functions
    pub fn VDBManagerRelease(self_: *const VDBManager) -> rc_t;
    pub fn VSchemaRelease(self_: *mut VSchema) -> rc_t;
    pub fn VDatabaseRelease(self_: *const VDatabase) -> rc_t;
    pub fn VTableRelease(self_: *const VTable) -> rc_t;
    pub fn VCursorRelease(self_: *const VCursor) -> rc_t;
}