ohos-rdb-sys 0.1.0

// automatically generated by rust-bindgen 0.71.1

#![allow(non_upper_case_globals)]
#![allow(non_camel_case_types)]
#![allow(non_snake_case)]
use crate::rdb_types::{Data_Asset, OH_ColumnType};

/// Define the OH_Cursor structure type.
///
/// Provides methods for accessing a database result set generated by query the database.
///
///
/// Available since API-level: 10
#[repr(C)]
#[derive(Debug, Copy, Clone)]
pub struct OH_Cursor {
    /// The id used to uniquely identify the OH_Cursor struct.
    pub id: i64,
    /// Function pointer. Obtains the total number of columns.
    ///
    /// # Arguments
    ///
    /// * `cursor` - Represents a pointer to an [`OH_Cursor`] instance.
    ///
    /// * `count` - This parameter is the output parameter, and the number of columns is written to this variable.
    ///
    /// # Returns
    ///
    /// * Returns the status code of the execution.
    /// [`OH_Cursor.`]
    /// Available since API-level: 10
    pub getColumnCount: ::core::option::Option<
        unsafe extern "C" fn(
            cursor: *mut OH_Cursor,
            count: *mut ::core::ffi::c_int,
        ) -> ::core::ffi::c_int,
    >,
    /// Function pointer. Obtains data type of the given column's value.
    ///
    /// # Arguments
    ///
    /// * `cursor` - Represents a pointer to an [`OH_Cursor`] instance.
    ///
    /// * `columnIndex` - Indicates the zero-based index of the target column.
    ///
    /// * `columnType` - This parameter is the output parameter, and the column value type is written to this variable.
    ///
    /// # Returns
    ///
    /// * Returns the status code of the execution.
    /// [`OH_Cursor,`] OH_ColumnType.
    ///
    /// Available since API-level: 10
    pub getColumnType: ::core::option::Option<
        unsafe extern "C" fn(
            cursor: *mut OH_Cursor,
            columnIndex: i32,
            columnType: *mut OH_ColumnType,
        ) -> ::core::ffi::c_int,
    >,
    /// Function pointer. Obtains the zero-based index for the given column name.
    ///
    /// # Arguments
    ///
    /// * `cursor` - Represents a pointer to an [`OH_Cursor`] instance.
    ///
    /// * `name` - Indicates the name of the column.
    ///
    /// * `columnIndex` - This parameter is the output parameter,
    /// and the column index for the given column is written to this variable.
    ///
    /// # Returns
    ///
    /// * Returns the status code of the execution.
    /// [`OH_Cursor.`]
    /// Available since API-level: 10
    pub getColumnIndex: ::core::option::Option<
        unsafe extern "C" fn(
            cursor: *mut OH_Cursor,
            name: *const ::core::ffi::c_char,
            columnIndex: *mut ::core::ffi::c_int,
        ) -> ::core::ffi::c_int,
    >,
    /// Function pointer. Obtains the column name at the given column index.
    ///
    /// # Arguments
    ///
    /// * `cursor` - Represents a pointer to an [`OH_Cursor`] instance.
    ///
    /// * `columnIndex` - Indicates the zero-based column index.
    ///
    /// * `name` - This parameter is the output parameter,
    /// and the column name for the given index is written to this variable.
    ///
    /// * `length` - Indicates the length of the name.
    ///
    /// # Returns
    ///
    /// * Returns the status code of the execution.
    /// [`OH_Cursor.`]
    /// Available since API-level: 10
    pub getColumnName: ::core::option::Option<
        unsafe extern "C" fn(
            cursor: *mut OH_Cursor,
            columnIndex: i32,
            name: *mut ::core::ffi::c_char,
            length: ::core::ffi::c_int,
        ) -> ::core::ffi::c_int,
    >,
    /// Function pointer. Obtains the numbers of rows in the result set.
    ///
    /// # Arguments
    ///
    /// * `cursor` - Represents a pointer to an [`OH_Cursor`] instance.
    ///
    /// * `count` - This parameter is the output parameter,
    /// and the numbers of rows in the result set is written to this variable.
    ///
    /// # Returns
    ///
    /// * Returns the status code of the execution.
    /// [`OH_Cursor.`]
    /// Available since API-level: 10
    pub getRowCount: ::core::option::Option<
        unsafe extern "C" fn(
            cursor: *mut OH_Cursor,
            count: *mut ::core::ffi::c_int,
        ) -> ::core::ffi::c_int,
    >,
    /// Function pointer. Move the cursor to the next row.
    ///
    /// # Arguments
    ///
    /// * `cursor` - Represents a pointer to an [`OH_Cursor`] instance.
    ///
    /// # Returns
    ///
    /// * Returns the status code of the execution.
    /// [`OH_Cursor.`]
    /// Available since API-level: 10
    pub goToNextRow:
        ::core::option::Option<unsafe extern "C" fn(cursor: *mut OH_Cursor) -> ::core::ffi::c_int>,
    /// Function pointer. Obtains the size of blob or text.
    ///
    /// # Arguments
    ///
    /// * `cursor` - Represents a pointer to an [`OH_Cursor`] instance.
    ///
    /// * `columnIndex` - Indicates the zero-based column index.
    ///
    /// * `size` - This parameter is the output parameter,
    /// and the value size of the requested column is written to this variable.
    ///
    /// # Returns
    ///
    /// * Returns the status code of the execution.
    /// [`OH_Cursor.`]
    /// Available since API-level: 10
    pub getSize: ::core::option::Option<
        unsafe extern "C" fn(
            cursor: *mut OH_Cursor,
            columnIndex: i32,
            size: *mut usize,
        ) -> ::core::ffi::c_int,
    >,
    /// Function pointer. Obtains the value of the requested column as a string.
    ///
    /// # Arguments
    ///
    /// * `cursor` - Represents a pointer to an [`OH_Cursor`] instance.
    ///
    /// * `columnIndex` - Indicates the zero-based column index.
    ///
    /// * `value` - This parameter is the output parameter,
    /// and the value of the requested column as a char * is written to this variable.
    ///
    /// * `length` - Indicates the length of the value, it can be obtained through the OH_Cursor_GetSize function.
    ///
    /// # Returns
    ///
    /// * Returns the status code of the execution.
    /// [`OH_Cursor.`]
    /// Available since API-level: 10
    pub getText: ::core::option::Option<
        unsafe extern "C" fn(
            cursor: *mut OH_Cursor,
            columnIndex: i32,
            value: *mut ::core::ffi::c_char,
            length: ::core::ffi::c_int,
        ) -> ::core::ffi::c_int,
    >,
    /// Function pointer. Obtains the value of the requested column as a int64_t.
    ///
    /// # Arguments
    ///
    /// * `cursor` - Represents a pointer to an [`OH_Cursor`] instance.
    ///
    /// * `columnIndex` - Indicates the zero-based column index.
    ///
    /// * `value` - This parameter is the output parameter,
    /// and the value of the requested column as a int64_t is written to this variable.
    ///
    /// # Returns
    ///
    /// * Returns the status code of the execution.
    /// [`OH_Cursor.`]
    /// Available since API-level: 10
    pub getInt64: ::core::option::Option<
        unsafe extern "C" fn(
            cursor: *mut OH_Cursor,
            columnIndex: i32,
            value: *mut i64,
        ) -> ::core::ffi::c_int,
    >,
    /// Function pointer. Obtains the value of the requested column as a double.
    ///
    /// # Arguments
    ///
    /// * `cursor` - Represents a pointer to an [`OH_Cursor`] instance.
    ///
    /// * `columnIndex` - Indicates the zero-based column index.
    ///
    /// * `value` - This parameter is the output parameter,
    /// and the value of the requested column as a double is written to this variable.
    ///
    /// # Returns
    ///
    /// * Returns the status code of the execution.
    /// [`OH_Cursor.`]
    /// Available since API-level: 10
    pub getReal: ::core::option::Option<
        unsafe extern "C" fn(
            cursor: *mut OH_Cursor,
            columnIndex: i32,
            value: *mut f64,
        ) -> ::core::ffi::c_int,
    >,
    /// Function pointer. Obtains the value of the requested column as a byte array.
    ///
    /// # Arguments
    ///
    /// * `cursor` - Represents a pointer to an [`OH_Cursor`] instance.
    ///
    /// * `columnIndex` - Indicates the zero-based column index.
    ///
    /// * `value` - This parameter is the output parameter,
    /// and the value of the requested column as a byte array is written to this variable.
    ///
    /// * `length` - Indicates the length of the value, it can be obtained through the OH_Cursor_GetSize function.
    ///
    /// # Returns
    ///
    /// * Returns the status code of the execution.
    /// [`OH_Cursor.`]
    /// Available since API-level: 10
    pub getBlob: ::core::option::Option<
        unsafe extern "C" fn(
            cursor: *mut OH_Cursor,
            columnIndex: i32,
            value: *mut ::core::ffi::c_uchar,
            length: ::core::ffi::c_int,
        ) -> ::core::ffi::c_int,
    >,
    /// Function pointer. Obtains Whether the value of the requested column is null.
    ///
    /// # Arguments
    ///
    /// * `cursor` - Represents a pointer to an [`OH_Cursor`] instance.
    ///
    /// * `columnIndex` - Indicates the zero-based column index.
    ///
    /// * `isNull` - This parameter is the output parameter,
    /// and the value whether the column value is null is written to this variable.
    ///
    /// # Returns
    ///
    /// * Returns the status code of the execution.
    /// [`OH_Cursor.`]
    /// Available since API-level: 10
    pub isNull: ::core::option::Option<
        unsafe extern "C" fn(
            cursor: *mut OH_Cursor,
            columnIndex: i32,
            isNull: *mut bool,
        ) -> ::core::ffi::c_int,
    >,
    /// Function pointer. Destroy the result set, releasing all of its resources and making it completely invalid.
    ///
    /// # Arguments
    ///
    /// * `cursor` - Represents a pointer to an [`OH_Cursor`] instance.
    ///
    /// # Returns
    ///
    /// * Returns the status code of the execution.
    /// [`OH_Cursor.`]
    /// Available since API-level: 10
    pub destroy:
        ::core::option::Option<unsafe extern "C" fn(cursor: *mut OH_Cursor) -> ::core::ffi::c_int>,
    /// Function pointer. Obtains the value of the requested column as an [`Data_Asset`] instance.
    ///
    /// # Arguments
    ///
    /// * `cursor` - Represents a pointer to an [`OH_Cursor`] instance.
    ///
    /// * `columnIndex` - Indicates the zero-based column index.
    ///
    /// * `value` - This parameter is the output parameter,
    /// and the value of the requested column as an [`Data_Asset`] instance is written to this variable.
    ///
    /// # Returns
    ///
    /// * Returns the status code of the execution.
    /// [`OH_Cursor.`]
    /// Available since API-level: 11
    pub getAsset: ::core::option::Option<
        unsafe extern "C" fn(
            cursor: *mut OH_Cursor,
            columnIndex: i32,
            value: *mut Data_Asset,
        ) -> ::core::ffi::c_int,
    >,
    /// Function pointer. Obtains the value of the requested column as an [`Data_Asset`] instance.
    ///
    /// # Arguments
    ///
    /// * `cursor` - Represents a pointer to an [`OH_Cursor`] instance.
    ///
    /// * `columnIndex` - Indicates the zero-based column index.
    ///
    /// * `value` - This parameter is the output parameter,
    /// and the value of the requested column as an [`Data_Asset`] instance is written to this variable.
    ///
    /// * `length` - Indicates the length of the value.
    ///
    /// # Returns
    ///
    /// * Returns the status code of the execution.
    /// [`OH_Cursor.`]
    /// Available since API-level: 11
    pub getAssets: ::core::option::Option<
        unsafe extern "C" fn(
            cursor: *mut OH_Cursor,
            columnIndex: i32,
            value: *mut *mut Data_Asset,
            length: *mut u32,
        ) -> ::core::ffi::c_int,
    >,
}
extern "C" {
    /// Get float array data size of the requested column from OH_Cursor object.
    ///
    /// # Arguments
    ///
    /// * `cursor` - Represents a pointer to an instance of OH_Cursor.
    ///
    /// * `columnIndex` - Indicates the zero-based column index.
    ///
    /// * `length` - Represents the size of float array. It is an output parameter.
    ///
    /// # Returns
    ///
    /// * Returns the status code of the execution.
    /// Returns [`RDB_OK`] if the execution is successful.
    /// Returns [`RDB_E_ERROR`] database common error.
    /// Returns [`RDB_E_INVALID_ARGS`] if invalid input parameter.
    /// Returns [`RDB_E_SQLITE_CORRUPT`] database corrupted.
    /// Returns [`RDB_E_STEP_RESULT_CLOSED`] the result set has been closed.
    /// Returns [`RDB_E_ALREADY_CLOSED`] database already closed.
    /// Returns [`RDB_E_SQLITE_PERM`] SQLite: Access permission denied.
    /// Returns [`RDB_E_SQLITE_BUSY`] SQLite: The database file is locked.
    /// Returns [`RDB_E_SQLITE_LOCKED`] SQLite: A table in the database is locked.
    /// Returns [`RDB_E_SQLITE_NOMEM`] SQLite: The database is out of memory.
    /// Returns [`RDB_E_SQLITE_IOERR`] SQLite: Some kind of disk I/O error occurred.
    /// Returns [`RDB_E_SQLITE_TOO_BIG`] SQLite: TEXT or BLOB exceeds size limit.
    /// Returns [`RDB_E_SQLITE_MISMATCH`] SQLite: Data type mismatch.
    ///
    /// Available since API-level: 18
    #[cfg(feature = "api-18")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-18")))]
    pub fn OH_Cursor_GetFloatVectorCount(
        cursor: *mut OH_Cursor,
        columnIndex: i32,
        length: *mut usize,
    ) -> ::core::ffi::c_int;
    /// Obtains the value of the requested column as a float array.
    ///
    /// # Arguments
    ///
    /// * `cursor` - Represents a pointer to an instance of OH_Cursor.
    ///
    /// * `columnIndex` - Indicates the zero-based column index.
    ///
    /// * `val` - Represents a pointer to float array. The caller needs to apply for data memory.
    /// This function only fills data. Otherwise, the execution fails.
    ///
    /// * `inLen` - Represents the size of val. It can be obtained through the OH_Cursor_GetFloatVectorCount function.
    ///
    /// * `outLen` - Represents the actual amount of data obtained. It is an output parameter.
    ///
    /// # Returns
    ///
    /// * Returns the status code of the execution.
    /// Returns [`RDB_OK`] if the execution is successful.
    /// Returns [`RDB_E_ERROR`] database common error.
    /// Returns [`RDB_E_INVALID_ARGS`] if invalid input parameter.
    /// Returns [`RDB_E_SQLITE_CORRUPT`] database corrupted.
    /// Returns [`RDB_E_STEP_RESULT_CLOSED`] the result set has been closed.
    /// Returns [`RDB_E_ALREADY_CLOSED`] database already closed.
    /// Returns [`RDB_E_SQLITE_PERM`] SQLite: Access permission denied.
    /// Returns [`RDB_E_SQLITE_BUSY`] SQLite: The database file is locked.
    /// Returns [`RDB_E_SQLITE_LOCKED`] SQLite: A table in the database is locked.
    /// Returns [`RDB_E_SQLITE_NOMEM`] SQLite: The database is out of memory.
    /// Returns [`RDB_E_SQLITE_IOERR`] SQLite: Some kind of disk I/O error occurred.
    /// Returns [`RDB_E_SQLITE_TOO_BIG`] SQLite: TEXT or BLOB exceeds size limit.
    /// Returns [`RDB_E_SQLITE_MISMATCH`] SQLite: Data type mismatch.
    /// [`OH_Cursor_GetFloatVectorCount.`]
    /// Available since API-level: 18
    #[cfg(feature = "api-18")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-18")))]
    pub fn OH_Cursor_GetFloatVector(
        cursor: *mut OH_Cursor,
        columnIndex: i32,
        val: *mut f32,
        inLen: usize,
        outLen: *mut usize,
    ) -> ::core::ffi::c_int;
}