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)]
#[cfg(feature = "api-20")]
use crate::rdb_types::OH_Data_Values;
use crate::value_object::OH_VObject;

impl OH_OrderType {
    /// Ascend order.
    pub const ASC: OH_OrderType = OH_OrderType(0);
    /// Descend order.
    pub const DESC: OH_OrderType = OH_OrderType(1);
}
#[repr(transparent)]
/// Result set sort type.
///
///
/// Available since API-level: 10
#[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
pub struct OH_OrderType(pub ::core::ffi::c_uint);
/// Define the OH_Predicates structure type.
///
///
/// Available since API-level: 10
#[repr(C)]
#[derive(Debug, Copy, Clone)]
pub struct OH_Predicates {
    /// The id used to uniquely identify the OH_Predicates struct.
    pub id: i64,
    /// Function pointer. Restricts the value of the field to be equal to the specified value to the predicates.
    ///
    /// This method is similar to = of the SQL statement.
    ///
    /// # Arguments
    ///
    /// * `predicates` - Represents a pointer to an [`OH_Predicates`] instance.
    ///
    /// * `field` - Indicates the column name in the database table.
    ///
    /// * `valueObject` - Represents a pointer to an [`OH_VObject`] instance.
    ///
    /// # Returns
    ///
    /// * Returns the self.
    /// [`OH_Predicates,`] OH_VObject.
    ///
    /// Available since API-level: 10
    pub equalTo: ::core::option::Option<
        unsafe extern "C" fn(
            predicates: *mut OH_Predicates,
            field: *const ::core::ffi::c_char,
            valueObject: *mut OH_VObject,
        ) -> *mut OH_Predicates,
    >,
    /// Function pointer.
    /// Restricts the value of the field to be not equal to the specified value to the predicates.
    ///
    /// This method is similar to != of the SQL statement.
    ///
    /// # Arguments
    ///
    /// * `predicates` - Represents a pointer to an [`OH_Predicates`] instance.
    ///
    /// * `field` - Indicates the column name in the database table.
    ///
    /// * `valueObject` - Represents a pointer to an [`OH_VObject`] instance.
    ///
    /// # Returns
    ///
    /// * Returns the self.
    /// [`OH_Predicates,`] OH_VObject.
    ///
    /// Available since API-level: 10
    pub notEqualTo: ::core::option::Option<
        unsafe extern "C" fn(
            predicates: *mut OH_Predicates,
            field: *const ::core::ffi::c_char,
            valueObject: *mut OH_VObject,
        ) -> *mut OH_Predicates,
    >,
    /// Function pointer. Add left parenthesis to predicate.
    ///
    /// This method is similar to ( of the SQL statement.
    ///
    /// # Arguments
    ///
    /// * `predicates` - Represents a pointer to an [`OH_Predicates`] instance.
    ///
    /// # Returns
    ///
    /// * Returns the self.
    /// [`OH_Predicates.`]
    /// Available since API-level: 10
    pub beginWrap: ::core::option::Option<
        unsafe extern "C" fn(predicates: *mut OH_Predicates) -> *mut OH_Predicates,
    >,
    /// Function pointer. Add right parenthesis to predicate.
    ///
    /// This method is similar to ) of the SQL statement.
    ///
    /// # Arguments
    ///
    /// * `predicates` - Represents a pointer to an [`OH_Predicates`] instance.
    ///
    /// # Returns
    ///
    /// * Returns the self.
    /// [`OH_Predicates.`]
    /// Available since API-level: 10
    pub endWrap: ::core::option::Option<
        unsafe extern "C" fn(predicates: *mut OH_Predicates) -> *mut OH_Predicates,
    >,
    /// Function pointer. Adds an or condition to the predicates.
    ///
    /// This method is similar to OR of the SQL statement.
    ///
    /// # Arguments
    ///
    /// * `predicates` - Represents a pointer to an [`OH_Predicates`] instance.
    ///
    /// # Returns
    ///
    /// * Returns the self.
    /// [`OH_Predicates.`]
    /// Available since API-level: 10
    pub orOperate: ::core::option::Option<
        unsafe extern "C" fn(predicates: *mut OH_Predicates) -> *mut OH_Predicates,
    >,
    /// Function pointer. Adds an and condition to the predicates.
    ///
    /// This method is similar to AND of the SQL statement.
    ///
    /// # Arguments
    ///
    /// * `predicates` - Represents a pointer to an [`OH_Predicates`] instance.
    ///
    /// # Returns
    ///
    /// * Returns the self.
    /// [`OH_Predicates.`]
    /// Available since API-level: 10
    pub andOperate: ::core::option::Option<
        unsafe extern "C" fn(predicates: *mut OH_Predicates) -> *mut OH_Predicates,
    >,
    /// Function pointer. Restricts the value of the field which is null to the predicates.
    ///
    /// This method is similar to IS NULL of the SQL statement.
    ///
    /// # Arguments
    ///
    /// * `predicates` - Represents a pointer to an [`OH_Predicates`] instance.
    ///
    /// * `field` - Indicates the column name in the database table.
    ///
    /// # Returns
    ///
    /// * Returns the self.
    /// [`OH_Predicates.`]
    /// Available since API-level: 10
    pub isNull: ::core::option::Option<
        unsafe extern "C" fn(
            predicates: *mut OH_Predicates,
            field: *const ::core::ffi::c_char,
        ) -> *mut OH_Predicates,
    >,
    /// Function pointer. Restricts the value of the field which is not null to the predicates.
    ///
    /// This method is similar to IS NOT NULL of the SQL statement.
    ///
    /// # Arguments
    ///
    /// * `predicates` - Represents a pointer to an [`OH_Predicates`] instance.
    ///
    /// * `field` - Indicates the column name in the database table.
    ///
    /// # Returns
    ///
    /// * Returns the self.
    /// [`OH_Predicates.`]
    /// Available since API-level: 10
    pub isNotNull: ::core::option::Option<
        unsafe extern "C" fn(
            predicates: *mut OH_Predicates,
            field: *const ::core::ffi::c_char,
        ) -> *mut OH_Predicates,
    >,
    /// Function pointer. Restricts the value of the field to be like the specified value to the predicates.
    ///
    /// This method is similar to LIKE of the SQL statement.
    ///
    /// # Arguments
    ///
    /// * `predicates` - Represents a pointer to an [`OH_Predicates`] instance.
    ///
    /// * `field` - Indicates the column name in the database table.
    ///
    /// * `valueObject` - Represents a pointer to an [`OH_VObject`] instance.
    ///
    /// # Returns
    ///
    /// * Returns the self.
    /// [`OH_Predicates,`] OH_VObject.
    ///
    /// Available since API-level: 10
    pub like: ::core::option::Option<
        unsafe extern "C" fn(
            predicates: *mut OH_Predicates,
            field: *const ::core::ffi::c_char,
            valueObject: *mut OH_VObject,
        ) -> *mut OH_Predicates,
    >,
    /// Function pointer. Restricts the value of the field to be between the specified value to the predicates.
    ///
    /// This method is similar to BETWEEN of the SQL statement.
    ///
    /// # Arguments
    ///
    /// * `predicates` - Represents a pointer to an [`OH_Predicates`] instance.
    ///
    /// * `field` - Indicates the column name in the database table.
    ///
    /// * `valueObject` - Represents a pointer to an [`OH_VObject`] instance.
    ///
    /// # Returns
    ///
    /// * Returns the self.
    /// [`OH_Predicates,`] OH_VObject.
    ///
    /// Available since API-level: 10
    pub between: ::core::option::Option<
        unsafe extern "C" fn(
            predicates: *mut OH_Predicates,
            field: *const ::core::ffi::c_char,
            valueObject: *mut OH_VObject,
        ) -> *mut OH_Predicates,
    >,
    /// Function pointer.
    /// Restricts the value of the field to be not between the specified value to the predicates.
    ///
    /// This method is similar to NOT BETWEEN of the SQL statement.
    ///
    /// # Arguments
    ///
    /// * `predicates` - Represents a pointer to an [`OH_Predicates`] instance.
    ///
    /// * `field` - Indicates the column name in the database table.
    ///
    /// * `valueObject` - Represents a pointer to an [`OH_VObject`] instance.
    ///
    /// # Returns
    ///
    /// * Returns the self.
    /// [`OH_Predicates,`] OH_VObject.
    ///
    /// Available since API-level: 10
    pub notBetween: ::core::option::Option<
        unsafe extern "C" fn(
            predicates: *mut OH_Predicates,
            field: *const ::core::ffi::c_char,
            valueObject: *mut OH_VObject,
        ) -> *mut OH_Predicates,
    >,
    /// Function pointer.
    /// Restricts the value of the field to be greater than the specified value to the predicates.
    ///
    /// This method is similar to > of the SQL statement.
    ///
    /// # Arguments
    ///
    /// * `predicates` - Represents a pointer to an [`OH_Predicates`] instance.
    ///
    /// * `field` - Indicates the column name in the database table.
    ///
    /// * `valueObject` - Represents a pointer to an [`OH_VObject`] instance.
    ///
    /// # Returns
    ///
    /// * Returns the self.
    /// [`OH_Predicates,`] OH_VObject.
    ///
    /// Available since API-level: 10
    pub greaterThan: ::core::option::Option<
        unsafe extern "C" fn(
            predicates: *mut OH_Predicates,
            field: *const ::core::ffi::c_char,
            valueObject: *mut OH_VObject,
        ) -> *mut OH_Predicates,
    >,
    /// Function pointer.
    /// Restricts the value of the field to be less than the specified value to the predicates.
    ///
    /// This method is similar to < of the SQL statement.
    ///
    /// # Arguments
    ///
    /// * `predicates` - Represents a pointer to an [`OH_Predicates`] instance.
    ///
    /// * `field` - Indicates the column name in the database table.
    ///
    /// * `valueObject` - Represents a pointer to an [`OH_VObject`] instance.
    ///
    /// # Returns
    ///
    /// * Returns the self.
    /// [`OH_Predicates,`] OH_VObject.
    ///
    /// Available since API-level: 10
    pub lessThan: ::core::option::Option<
        unsafe extern "C" fn(
            predicates: *mut OH_Predicates,
            field: *const ::core::ffi::c_char,
            valueObject: *mut OH_VObject,
        ) -> *mut OH_Predicates,
    >,
    /// Function pointer.
    /// Restricts the value of the field to be greater than or equal to the specified value to the predicates.
    ///
    /// This method is similar to >= of the SQL statement.
    ///
    /// # Arguments
    ///
    /// * `predicates` - Represents a pointer to an [`OH_Predicates`] instance.
    ///
    /// * `field` - Indicates the column name in the database table.
    ///
    /// * `valueObject` - Represents a pointer to an [`OH_VObject`] instance.
    ///
    /// # Returns
    ///
    /// * Returns the self.
    /// [`OH_Predicates,`] OH_VObject.
    ///
    /// Available since API-level: 10
    pub greaterThanOrEqualTo: ::core::option::Option<
        unsafe extern "C" fn(
            predicates: *mut OH_Predicates,
            field: *const ::core::ffi::c_char,
            valueObject: *mut OH_VObject,
        ) -> *mut OH_Predicates,
    >,
    /// Function pointer.
    /// Restricts the value of the field to be less than or equal to the specified value to the predicates.
    ///
    /// This method is similar to <= of the SQL statement.
    ///
    /// # Arguments
    ///
    /// * `predicates` - Represents a pointer to an [`OH_Predicates`] instance.
    ///
    /// * `field` - Indicates the column name in the database table.
    ///
    /// * `valueObject` - Represents a pointer to an [`OH_VObject`] instance.
    ///
    /// # Returns
    ///
    /// * Returns the self.
    /// [`OH_Predicates,`] OH_VObject.
    ///
    /// Available since API-level: 10
    pub lessThanOrEqualTo: ::core::option::Option<
        unsafe extern "C" fn(
            predicates: *mut OH_Predicates,
            field: *const ::core::ffi::c_char,
            valueObject: *mut OH_VObject,
        ) -> *mut OH_Predicates,
    >,
    /// Function pointer. Restricts the ascending or descending order of the return list.
    /// When there are several orders, the one close to the head has the highest priority.
    ///
    /// This method is similar ORDER BY the SQL statement.
    ///
    /// # Arguments
    ///
    /// * `predicates` - Represents a pointer to an [`OH_Predicates`] instance.
    ///
    /// * `field` - Indicates the column name in the database table.
    ///
    /// * `type` - Indicates the sort [`OH_OrderType`] type.
    ///
    /// # Returns
    ///
    /// * Returns the self.
    /// [`OH_Predicates,`] OH_OrderType.
    ///
    /// Available since API-level: 10
    pub orderBy: ::core::option::Option<
        unsafe extern "C" fn(
            predicates: *mut OH_Predicates,
            field: *const ::core::ffi::c_char,
            type_: OH_OrderType,
        ) -> *mut OH_Predicates,
    >,
    /// Function pointer. Configure predicates to filter duplicate records and retain only one of them.
    ///
    /// This method is similar DISTINCT the SQL statement.
    ///
    /// # Arguments
    ///
    /// * `predicates` - Represents a pointer to an [`OH_Predicates`] instance.
    ///
    /// # Returns
    ///
    /// * Returns the self.
    /// [`OH_Predicates.`]
    /// Available since API-level: 10
    pub distinct: ::core::option::Option<
        unsafe extern "C" fn(predicates: *mut OH_Predicates) -> *mut OH_Predicates,
    >,
    /// Function pointer. Predicate for setting the maximum number of data records.
    ///
    /// This method is similar LIMIT the SQL statement.
    ///
    /// # Arguments
    ///
    /// * `predicates` - Represents a pointer to an [`OH_Predicates`] instance.
    ///
    /// * `value` - Indicates the maximum number of records.
    ///
    /// # Returns
    ///
    /// * Returns the self.
    /// [`OH_Predicates.`]
    /// Available since API-level: 10
    pub limit: ::core::option::Option<
        unsafe extern "C" fn(
            predicates: *mut OH_Predicates,
            value: ::core::ffi::c_uint,
        ) -> *mut OH_Predicates,
    >,
    /// Function pointer. Configure the predicate to specify the starting position of the returned result.
    ///
    /// This method is similar OFFSET the SQL statement.
    ///
    /// # Arguments
    ///
    /// * `predicates` - Represents a pointer to an [`OH_Predicates`] instance.
    ///
    /// * `rowOffset` - Indicates the number of rows to offset from the beginning. The value is a positive integer.
    ///
    /// # Returns
    ///
    /// * Returns the self.
    /// [`OH_Predicates.`]
    /// Available since API-level: 10
    pub offset: ::core::option::Option<
        unsafe extern "C" fn(
            predicates: *mut OH_Predicates,
            rowOffset: ::core::ffi::c_uint,
        ) -> *mut OH_Predicates,
    >,
    /// Function pointer. Configure predicates to group query results by specified columns.
    ///
    /// This method is similar GROUP BY the SQL statement.
    ///
    /// # Arguments
    ///
    /// * `predicates` - Represents a pointer to an [`OH_Predicates`] instance.
    ///
    /// * `fields` - Indicates the column names that the grouping depends on.
    ///
    /// * `length` - Indicates the length of fields.
    ///
    /// # Returns
    ///
    /// * Returns the self.
    /// [`OH_Predicates.`]
    /// Available since API-level: 10
    pub groupBy: ::core::option::Option<
        unsafe extern "C" fn(
            predicates: *mut OH_Predicates,
            fields: *const *const ::core::ffi::c_char,
            length: ::core::ffi::c_int,
        ) -> *mut OH_Predicates,
    >,
    /// Function pointer.
    /// Configure the predicate to match the specified field and the value within the given array range.
    ///
    /// This method is similar IN the SQL statement.
    ///
    /// # Arguments
    ///
    /// * `predicates` - Represents a pointer to an [`OH_Predicates`] instance.
    ///
    /// * `field` - Indicates the column name in the database table.
    ///
    /// * `valueObject` - Represents a pointer to an [`OH_VObject`] instance.
    ///
    /// # Returns
    ///
    /// * Returns the self.
    /// [`OH_Predicates,`] OH_VObject.
    ///
    /// Available since API-level: 10
    pub in_: ::core::option::Option<
        unsafe extern "C" fn(
            predicates: *mut OH_Predicates,
            field: *const ::core::ffi::c_char,
            valueObject: *mut OH_VObject,
        ) -> *mut OH_Predicates,
    >,
    /// Function pointer.
    /// Configure the predicate to match the specified field and the value not within the given array range.
    ///
    /// This method is similar NOT IN the SQL statement.
    ///
    /// # Arguments
    ///
    /// * `predicates` - Represents a pointer to an [`OH_Predicates`] instance.
    ///
    /// * `field` - Indicates the column name in the database table.
    ///
    /// * `valueObject` - Represents a pointer to an [`OH_VObject`] instance.
    ///
    /// # Returns
    ///
    /// * Returns the self.
    /// [`OH_Predicates,`] OH_VObject.
    ///
    /// Available since API-level: 10
    pub notIn: ::core::option::Option<
        unsafe extern "C" fn(
            predicates: *mut OH_Predicates,
            field: *const ::core::ffi::c_char,
            valueObject: *mut OH_VObject,
        ) -> *mut OH_Predicates,
    >,
    /// Function pointer. Initialize OH_Predicates object.
    ///
    /// # Arguments
    ///
    /// * `predicates` - Represents a pointer to an [`OH_Predicates`] instance.
    ///
    /// # Returns
    ///
    /// * Returns the self.
    /// [`OH_Predicates.`]
    /// Available since API-level: 10
    pub clear: ::core::option::Option<
        unsafe extern "C" fn(predicates: *mut OH_Predicates) -> *mut OH_Predicates,
    >,
    /// Destroy the [`OH_Predicates`] object and reclaim the memory occupied by the object.
    ///
    /// # Arguments
    ///
    /// * `predicates` - Represents a pointer to an [`OH_Predicates`] instance.
    ///
    /// # Returns
    ///
    /// * Returns the status code of the execution..
    /// [`OH_Predicates.`]
    /// Available since API-level: 10
    pub destroy: ::core::option::Option<
        unsafe extern "C" fn(predicates: *mut OH_Predicates) -> ::core::ffi::c_int,
    >,
}
extern "C" {
    /// Sets the OH_Predicates to match the field whose data type is string and value is not like the specified value.
    /// This method is similar to "Not like" of the SQL statement.
    ///
    /// # Arguments
    ///
    /// * `predicates` - Represents a pointer to an instance of OH_Predicates.
    ///
    /// * `field` - Indicates the column name in the database table.
    ///
    /// * `pattern` - Indicates the value to compare against.
    ///
    /// # Returns
    ///
    /// * Returns the error code.
    /// Returns [`RDB_OK`] if the execution is successful.
    /// Returns [`RDB_E_INVALID_ARGS`] if invalid input parameter.
    ///
    /// Available since API-level: 20
    #[cfg(feature = "api-20")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-20")))]
    pub fn OH_Predicates_NotLike(
        predicates: *mut OH_Predicates,
        field: *const ::core::ffi::c_char,
        pattern: *const ::core::ffi::c_char,
    ) -> ::core::ffi::c_int;
    /// Sets the OH_Predicates to match the specified field whose data type is string and the value contains
    /// a wildcard. Different from like, the input parameters of this method are case-sensitive.
    ///
    /// # Arguments
    ///
    /// * `predicates` - Represents a pointer to an instance of OH_Predicates.
    ///
    /// * `field` - Indicates the column name in the database table.
    ///
    /// * `pattern` - Indicates the value to match with the predicate.
    ///
    /// # Returns
    ///
    /// * Returns the error code.
    /// Returns [`RDB_OK`] if the execution is successful.
    /// Returns [`RDB_E_INVALID_ARGS`] if invalid input parameter.
    ///
    /// Available since API-level: 20
    #[cfg(feature = "api-20")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-20")))]
    pub fn OH_Predicates_Glob(
        predicates: *mut OH_Predicates,
        field: *const ::core::ffi::c_char,
        pattern: *const ::core::ffi::c_char,
    ) -> ::core::ffi::c_int;
    /// Sets the OH_Predicates to not match the specified field whose data type is string and the value contains
    /// a wildcard. Different from not like, the input parameters of this method are case-sensitive.
    ///
    /// # Arguments
    ///
    /// * `predicates` - Represents a pointer to an instance of OH_Predicates.
    ///
    /// * `field` - Indicates the column name in the database table.
    ///
    /// * `pattern` - Indicates the value to compare against.
    ///
    /// # Returns
    ///
    /// * Returns the error code.
    /// Returns [`RDB_OK`] if the execution is successful.
    /// Returns [`RDB_E_INVALID_ARGS`] if invalid input parameter.
    ///
    /// Available since API-level: 20
    #[cfg(feature = "api-20")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-20")))]
    pub fn OH_Predicates_NotGlob(
        predicates: *mut OH_Predicates,
        field: *const ::core::ffi::c_char,
        pattern: *const ::core::ffi::c_char,
    ) -> ::core::ffi::c_int;
    /// Sets the OH_Predicates to specify conditions to filter grouped results that will appear in the final result.
    ///
    /// # Arguments
    ///
    /// * `predicates` - Represents a pointer to an instance of OH_Predicates.
    ///
    /// * `conditions` - Indicates filter conditions in the having clause.
    ///
    /// * `values` - Indicates a pointer to an instance of OH_Data_Values.
    ///
    /// # Returns
    ///
    /// * Returns the error code.
    /// Returns [`RDB_OK`] if the execution is successful.
    /// Returns [`RDB_E_INVALID_ARGS`] if invalid input parameter.
    ///
    /// Available since API-level: 20
    #[cfg(feature = "api-20")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-20")))]
    pub fn OH_Predicates_Having(
        predicates: *mut OH_Predicates,
        conditions: *const ::core::ffi::c_char,
        values: *const OH_Data_Values,
    ) -> ::core::ffi::c_int;
}