ohos-rdb-sys 0.1.0

Raw bindings to the OpenHarmony relational database (RDB) API
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

// automatically generated by rust-bindgen 0.71.1

#![allow(non_upper_case_globals)]
#![allow(non_camel_case_types)]
#![allow(non_snake_case)]
#[cfg(feature = "api-11")]
use crate::rdb_types::Data_Asset;

/// Define the OH_VBucket structure type.
///
///
/// Available since API-level: 10
#[repr(C)]
#[derive(Debug, Copy, Clone)]
pub struct OH_VBucket {
    /// The id used to uniquely identify the OH_VBucket struct.
    pub id: i64,
    /// Indicates the capability of OH_VBucket.
    pub capability: u16,
    /// Put the const char * value to this [`OH_VBucket`] object for the given column name.
    ///
    /// # Arguments
    ///
    /// * `bucket` - Represents a pointer to an [`OH_VBucket`] instance.
    ///
    /// * `field` - Indicates the name of the column.
    ///
    /// * `value` - Indicates the const char * value.
    ///
    /// # Returns
    ///
    /// * Returns the status code of the execution.
    /// [`OH_VBucket.`]
    /// Available since API-level: 10
    pub putText: ::core::option::Option<
        unsafe extern "C" fn(
            bucket: *mut OH_VBucket,
            field: *const ::core::ffi::c_char,
            value: *const ::core::ffi::c_char,
        ) -> ::core::ffi::c_int,
    >,
    /// Put the int64 value to this [`OH_VBucket`] object for the given column name.
    ///
    /// # Arguments
    ///
    /// * `bucket` - Represents a pointer to an [`OH_VBucket`] instance.
    ///
    /// * `field` - Indicates the name of the column.
    ///
    /// * `value` - Indicates the int64 value.
    ///
    /// # Returns
    ///
    /// * Returns the status code of the execution.
    /// [`OH_VBucket.`]
    /// Available since API-level: 10
    pub putInt64: ::core::option::Option<
        unsafe extern "C" fn(
            bucket: *mut OH_VBucket,
            field: *const ::core::ffi::c_char,
            value: i64,
        ) -> ::core::ffi::c_int,
    >,
    /// Put the double value to this [`OH_VBucket`] object for the given column name.
    ///
    /// # Arguments
    ///
    /// * `bucket` - Represents a pointer to an [`OH_VBucket`] instance.
    ///
    /// * `field` - Indicates the name of the column.
    ///
    /// * `value` - Indicates the double value.
    ///
    /// # Returns
    ///
    /// * Returns the status code of the execution.
    /// [`OH_VBucket.`]
    /// Available since API-level: 10
    pub putReal: ::core::option::Option<
        unsafe extern "C" fn(
            bucket: *mut OH_VBucket,
            field: *const ::core::ffi::c_char,
            value: f64,
        ) -> ::core::ffi::c_int,
    >,
    /// Put the const uint8_t * value to this [`OH_VBucket`] object for the given column name.
    ///
    /// # Arguments
    ///
    /// * `bucket` - Represents a pointer to an [`OH_VBucket`] instance.
    ///
    /// * `field` - Indicates the name of the column.
    ///
    /// * `value` - Indicates the const uint8_t * value.
    ///
    /// * `size` - Indicates the size of value.
    ///
    /// # Returns
    ///
    /// * Returns the status code of the execution.
    /// [`OH_VBucket.`]
    /// Available since API-level: 10
    pub putBlob: ::core::option::Option<
        unsafe extern "C" fn(
            bucket: *mut OH_VBucket,
            field: *const ::core::ffi::c_char,
            value: *const u8,
            size: u32,
        ) -> ::core::ffi::c_int,
    >,
    /// Put NULL to this [`OH_VBucket`] object for the given column name.
    ///
    /// # Arguments
    ///
    /// * `bucket` - Represents a pointer to an [`OH_VBucket`] instance.
    ///
    /// * `field` - Indicates the name of the column.
    ///
    /// # Returns
    ///
    /// * Returns the status code of the execution.
    /// [`OH_VBucket.`]
    /// Available since API-level: 10
    pub putNull: ::core::option::Option<
        unsafe extern "C" fn(
            bucket: *mut OH_VBucket,
            field: *const ::core::ffi::c_char,
        ) -> ::core::ffi::c_int,
    >,
    /// Clear the [`OH_VBucket`] object's values.
    ///
    /// # Arguments
    ///
    /// * `bucket` - Represents a pointer to an [`OH_VBucket`] instance.
    ///
    /// # Returns
    ///
    /// * Returns the status code of the execution.
    /// [`OH_VBucket.`]
    /// Available since API-level: 10
    pub clear:
        ::core::option::Option<unsafe extern "C" fn(bucket: *mut OH_VBucket) -> ::core::ffi::c_int>,
    /// Destroy the [`OH_VBucket`] object and reclaim the memory occupied by the object.
    ///
    /// # Arguments
    ///
    /// * `bucket` - Represents a pointer to an [`OH_VBucket`] instance.
    ///
    /// # Returns
    ///
    /// * Returns the status code of the execution.
    /// [`OH_VBucket.`]
    /// Available since API-level: 10
    pub destroy:
        ::core::option::Option<unsafe extern "C" fn(bucket: *mut OH_VBucket) -> ::core::ffi::c_int>,
}
extern "C" {
    /// Put the [`Data_Asset`] * value to this [`OH_VBucket`] object for the given column name.
    ///
    /// # Arguments
    ///
    /// * `bucket` - Represents a pointer to an [`OH_VBucket`] instance.
    ///
    /// * `field` - Indicates the name of the column.
    ///
    /// * `value` - Indicates the const [`Data_Asset`] * value.
    ///
    /// # Returns
    ///
    /// * Returns the status code of the execution.
    /// [`RDB_OK`] - success.
    /// [`RDB_E_INVALID_ARGS`] - The error code for common invalid args.
    /// [`OH_VBucket.`]
    /// Available since API-level: 11
    #[cfg(feature = "api-11")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-11")))]
    pub fn OH_VBucket_PutAsset(
        bucket: *mut OH_VBucket,
        field: *const ::core::ffi::c_char,
        value: *mut Data_Asset,
    ) -> ::core::ffi::c_int;
    /// Put the [`Data_Asset`] * value of given count to this [`OH_VBucket`] object for the given column name.
    ///
    /// # Arguments
    ///
    /// * `bucket` - Represents a pointer to an [`OH_VBucket`] instance.
    ///
    /// * `field` - Indicates the name of the column.
    ///
    /// * `value` - Indicates the [`Data_Asset`] value of given count.
    ///
    /// * `count` - Indicates the count of value.
    ///
    /// # Returns
    ///
    /// * Returns the status code of the execution.
    /// [`RDB_OK`] - success.
    /// [`RDB_E_INVALID_ARGS`] - The error code for common invalid args.
    /// [`OH_VBucket.`]
    /// Available since API-level: 11
    #[cfg(feature = "api-11")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-11")))]
    pub fn OH_VBucket_PutAssets(
        bucket: *mut OH_VBucket,
        field: *const ::core::ffi::c_char,
        value: *mut *mut Data_Asset,
        count: u32,
    ) -> ::core::ffi::c_int;
    /// Put the float vector to the OH_VBucket object.
    ///
    /// # Arguments
    ///
    /// * `bucket` - Represents a pointer to an [`OH_VBucket`] instance.
    ///
    /// * `field` - Represents the name of the column.
    ///
    /// * `vec` - Represents a pointer to float array.
    ///
    /// * `len` - Represents the size of float array.
    ///
    /// # Returns
    ///
    /// * Returns the status code of the execution.
    /// [`RDB_OK`] - success.
    /// [`RDB_E_INVALID_ARGS`] - The error code for common invalid args.
    /// [`OH_VBucket.`]
    /// Available since API-level: 18
    #[cfg(feature = "api-18")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-18")))]
    pub fn OH_VBucket_PutFloatVector(
        bucket: *mut OH_VBucket,
        field: *const ::core::ffi::c_char,
        vec: *const f32,
        len: usize,
    ) -> ::core::ffi::c_int;
    /// Put the an integer of any length to the OH_VBucket object.
    ///
    /// # Arguments
    ///
    /// * `bucket` - Represents a pointer to an [`OH_VBucket`] instance.
    ///
    /// * `field` - Represents the name of the column.
    ///
    /// * `sign` - Represents 0 is positive integer, 1 is negative integer.
    ///
    /// * `trueForm` - Represents a pointer to integer array.
    ///
    /// * `len` - Represents the size of integer array.
    ///
    /// # Returns
    ///
    /// * Returns the status code of the execution.
    /// [`RDB_OK`] - success.
    /// [`RDB_E_INVALID_ARGS`] - The error code for common invalid args.
    /// [`OH_VBucket.`]
    /// Available since API-level: 18
    #[cfg(feature = "api-18")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-18")))]
    pub fn OH_VBucket_PutUnlimitedInt(
        bucket: *mut OH_VBucket,
        field: *const ::core::ffi::c_char,
        sign: ::core::ffi::c_int,
        trueForm: *const u64,
        len: usize,
    ) -> ::core::ffi::c_int;
}