rust-samp-sdk 3.6.0

Low-level FFI bindings for the SA-MP AMX virtual machine and open.mp native component ABI. Used internally by `rust-samp`; depend on it directly only if you need raw access without the higher-level macros and lifecycle.
Documentation
//! `IDatabaseResultSet` — generated by `cargo xtask gen-omp` from `Server/Components/Databases/databases.hpp`.
//! Implemented by `DatabaseResultSet` in the server's `Databases`.
//!
//! Do not edit: change `xtask/omp-wrappers.toml` or the generator and
//! regenerate. Slots are clang's layout of the header for each ABI, checked
//! against the official binaries by `cargo xtask check-abi --generated`.

#![allow(unused_imports)]

use crate::omp::containers::{FlatSet, HybridString, Pair, Span};
use crate::omp::types::{
    Colour, GTAQuat, Hours, Microseconds, Milliseconds, Minutes, Seconds, StringView, TimePoint,
    UID, Vector2, Vector3, Vector4, WorldTimePoint,
};
use crate::omp::vtable::{call_vtable_small_struct, opaque, slots, virtual_fns};
use crate::omp::*;

opaque! {
    /// Opaque handle for `IDatabaseResultSet*`.
    pub IDatabaseResultSet;
}

slots! {
    /// `std::size_t IDatabaseResultSet::getRowCount()`
    SLOT_GET_ROW_COUNT: usize = 6, 5;
    /// `bool IDatabaseResultSet::selectNextRow()`
    SLOT_SELECT_NEXT_ROW: usize = 7, 6;
    /// `std::size_t IDatabaseResultSet::getFieldCount()`
    SLOT_GET_FIELD_COUNT: usize = 8, 7;
    /// `bool IDatabaseResultSet::isFieldNameAvailable(StringView)`
    SLOT_IS_FIELD_NAME_AVAILABLE: usize = 9, 8;
    /// `StringView IDatabaseResultSet::getFieldName(std::size_t)`
    SLOT_GET_FIELD_NAME: usize = 10, 9;
    /// `StringView IDatabaseResultSet::getFieldString(std::size_t)`
    SLOT_GET_FIELD_STRING: usize = 11, 10;
    /// `long IDatabaseResultSet::getFieldInt(std::size_t)`
    SLOT_GET_FIELD_INT: usize = 12, 11;
    /// `double IDatabaseResultSet::getFieldFloat(std::size_t)`
    SLOT_GET_FIELD_FLOAT: usize = 13, 12;
    /// `StringView IDatabaseResultSet::getFieldStringByName(StringView)`
    SLOT_GET_FIELD_STRING_BY_NAME: usize = 14, 13;
    /// `long IDatabaseResultSet::getFieldIntByName(StringView)`
    SLOT_GET_FIELD_INT_BY_NAME: usize = 15, 14;
    /// `double IDatabaseResultSet::getFieldFloatByName(StringView)`
    SLOT_GET_FIELD_FLOAT_BY_NAME: usize = 16, 15;
    /// `LegacyDBResult & IDatabaseResultSet::getLegacyDBResult()`
    SLOT_GET_LEGACY_DB_RESULT: usize = 17, 16;
}

virtual_fns! {
    /// `std::size_t IDatabaseResultSet::getRowCount()`.
    ///
    /// # Safety
    /// `result` must be a live `IDatabaseResultSet`.
    #[must_use]
    pub fn db_result_row_count(result: IDatabaseResultSet) -> usize = [0, SLOT_GET_ROW_COUNT] or 0;

    /// `bool IDatabaseResultSet::selectNextRow()`.
    ///
    /// # Safety
    /// `result` must be a live `IDatabaseResultSet`.
    #[must_use]
    pub fn db_result_select_next_row(
        result: IDatabaseResultSet,
    ) -> bool = [0, SLOT_SELECT_NEXT_ROW] or false;

    /// `std::size_t IDatabaseResultSet::getFieldCount()`.
    ///
    /// # Safety
    /// `result` must be a live `IDatabaseResultSet`.
    #[must_use]
    pub fn db_result_field_count(
        result: IDatabaseResultSet,
    ) -> usize = [0, SLOT_GET_FIELD_COUNT] or 0;

    /// `bool IDatabaseResultSet::isFieldNameAvailable(StringView)`.
    ///
    /// # Safety
    /// `result` must be a live `IDatabaseResultSet`.
    #[must_use]
    pub fn db_result_is_field_name_available(
        result: IDatabaseResultSet,
        field_name: StringView,
    ) -> bool = [0, SLOT_IS_FIELD_NAME_AVAILABLE] or false;

    /// `long IDatabaseResultSet::getFieldInt(std::size_t)`.
    ///
    /// # Safety
    /// `result` must be a live `IDatabaseResultSet`.
    #[must_use]
    pub fn db_result_field_int(
        result: IDatabaseResultSet,
        field_index: usize,
    ) -> i32 = [0, SLOT_GET_FIELD_INT] or 0;

    /// `double IDatabaseResultSet::getFieldFloat(std::size_t)`.
    ///
    /// # Safety
    /// `result` must be a live `IDatabaseResultSet`.
    #[must_use]
    pub fn db_result_field_float(
        result: IDatabaseResultSet,
        field_index: usize,
    ) -> f64 = [0, SLOT_GET_FIELD_FLOAT] or 0.0;

    /// `long IDatabaseResultSet::getFieldIntByName(StringView)`.
    ///
    /// # Safety
    /// `result` must be a live `IDatabaseResultSet`.
    #[must_use]
    pub fn db_result_field_int_by_name(
        result: IDatabaseResultSet,
        field_name: StringView,
    ) -> i32 = [0, SLOT_GET_FIELD_INT_BY_NAME] or 0;

    /// `double IDatabaseResultSet::getFieldFloatByName(StringView)`.
    ///
    /// # Safety
    /// `result` must be a live `IDatabaseResultSet`.
    #[must_use]
    pub fn db_result_field_float_by_name(
        result: IDatabaseResultSet,
        field_name: StringView,
    ) -> f64 = [0, SLOT_GET_FIELD_FLOAT_BY_NAME] or 0.0;

    /// `LegacyDBResult & IDatabaseResultSet::getLegacyDBResult()`.
    ///
    /// # Safety
    /// `result` must be a live `IDatabaseResultSet`.
    #[must_use]
    pub fn db_result_legacy_db_result(
        result: IDatabaseResultSet,
    ) -> *mut LegacyDBResult = [0, SLOT_GET_LEGACY_DB_RESULT] or std::ptr::null_mut();
}

/// `StringView IDatabaseResultSet::getFieldName(std::size_t)`.
///
/// # Safety
/// `result` must be a live `IDatabaseResultSet`.
#[must_use]
pub unsafe fn db_result_field_name(
    result: *mut IDatabaseResultSet,
    field_index: usize,
) -> Option<String> {
    let view = call_vtable_small_struct!(
        result.cast::<u8>(),
        0,
        SLOT_GET_FIELD_NAME,
        StringView,
        StringView::EMPTY,
        (usize)(field_index)
    )?;
    unsafe { view.to_owned_string() }
}

/// `StringView IDatabaseResultSet::getFieldString(std::size_t)`.
///
/// # Safety
/// `result` must be a live `IDatabaseResultSet`.
#[must_use]
pub unsafe fn db_result_field_string(
    result: *mut IDatabaseResultSet,
    field_index: usize,
) -> Option<String> {
    let view = call_vtable_small_struct!(
        result.cast::<u8>(),
        0,
        SLOT_GET_FIELD_STRING,
        StringView,
        StringView::EMPTY,
        (usize)(field_index)
    )?;
    unsafe { view.to_owned_string() }
}

/// `StringView IDatabaseResultSet::getFieldStringByName(StringView)`.
///
/// # Safety
/// `result` must be a live `IDatabaseResultSet`.
#[must_use]
pub unsafe fn db_result_field_string_by_name(
    result: *mut IDatabaseResultSet,
    field_name: StringView,
) -> Option<String> {
    let view = call_vtable_small_struct!(
        result.cast::<u8>(),
        0,
        SLOT_GET_FIELD_STRING_BY_NAME,
        StringView,
        StringView::EMPTY,
        (StringView)(field_name)
    )?;
    unsafe { view.to_owned_string() }
}