samp_sdk/omp/generated/
db_result.rs

1//! `IDatabaseResultSet` — generated by `cargo xtask gen-omp` from `Server/Components/Databases/databases.hpp`.
2//! Implemented by `DatabaseResultSet` in the server's `Databases`.
3//!
4//! Do not edit: change `xtask/omp-wrappers.toml` or the generator and
5//! regenerate. Slots are clang's layout of the header for each ABI, checked
6//! against the official binaries by `cargo xtask check-abi --generated`.
7
8#![allow(unused_imports)]
9
10use crate::omp::containers::{FlatSet, HybridString, Pair, Span};
11use crate::omp::types::{
12    Colour, GTAQuat, Hours, Microseconds, Milliseconds, Minutes, Seconds, StringView, TimePoint,
13    UID, Vector2, Vector3, Vector4, WorldTimePoint,
14};
15use crate::omp::vtable::{call_vtable_small_struct, opaque, slots, virtual_fns};
16use crate::omp::*;
17
18opaque! {
19    /// Opaque handle for `IDatabaseResultSet*`.
20    pub IDatabaseResultSet;
21}
22
23slots! {
24    /// `std::size_t IDatabaseResultSet::getRowCount()`
25    SLOT_GET_ROW_COUNT: usize = 6, 5;
26    /// `bool IDatabaseResultSet::selectNextRow()`
27    SLOT_SELECT_NEXT_ROW: usize = 7, 6;
28    /// `std::size_t IDatabaseResultSet::getFieldCount()`
29    SLOT_GET_FIELD_COUNT: usize = 8, 7;
30    /// `bool IDatabaseResultSet::isFieldNameAvailable(StringView)`
31    SLOT_IS_FIELD_NAME_AVAILABLE: usize = 9, 8;
32    /// `StringView IDatabaseResultSet::getFieldName(std::size_t)`
33    SLOT_GET_FIELD_NAME: usize = 10, 9;
34    /// `StringView IDatabaseResultSet::getFieldString(std::size_t)`
35    SLOT_GET_FIELD_STRING: usize = 11, 10;
36    /// `long IDatabaseResultSet::getFieldInt(std::size_t)`
37    SLOT_GET_FIELD_INT: usize = 12, 11;
38    /// `double IDatabaseResultSet::getFieldFloat(std::size_t)`
39    SLOT_GET_FIELD_FLOAT: usize = 13, 12;
40    /// `StringView IDatabaseResultSet::getFieldStringByName(StringView)`
41    SLOT_GET_FIELD_STRING_BY_NAME: usize = 14, 13;
42    /// `long IDatabaseResultSet::getFieldIntByName(StringView)`
43    SLOT_GET_FIELD_INT_BY_NAME: usize = 15, 14;
44    /// `double IDatabaseResultSet::getFieldFloatByName(StringView)`
45    SLOT_GET_FIELD_FLOAT_BY_NAME: usize = 16, 15;
46    /// `LegacyDBResult & IDatabaseResultSet::getLegacyDBResult()`
47    SLOT_GET_LEGACY_DB_RESULT: usize = 17, 16;
48}
49
50virtual_fns! {
51    /// `std::size_t IDatabaseResultSet::getRowCount()`.
52    ///
53    /// # Safety
54    /// `result` must be a live `IDatabaseResultSet`.
55    #[must_use]
56    pub fn db_result_row_count(result: IDatabaseResultSet) -> usize = [0, SLOT_GET_ROW_COUNT] or 0;
57
58    /// `bool IDatabaseResultSet::selectNextRow()`.
59    ///
60    /// # Safety
61    /// `result` must be a live `IDatabaseResultSet`.
62    #[must_use]
63    pub fn db_result_select_next_row(
64        result: IDatabaseResultSet,
65    ) -> bool = [0, SLOT_SELECT_NEXT_ROW] or false;
66
67    /// `std::size_t IDatabaseResultSet::getFieldCount()`.
68    ///
69    /// # Safety
70    /// `result` must be a live `IDatabaseResultSet`.
71    #[must_use]
72    pub fn db_result_field_count(
73        result: IDatabaseResultSet,
74    ) -> usize = [0, SLOT_GET_FIELD_COUNT] or 0;
75
76    /// `bool IDatabaseResultSet::isFieldNameAvailable(StringView)`.
77    ///
78    /// # Safety
79    /// `result` must be a live `IDatabaseResultSet`.
80    #[must_use]
81    pub fn db_result_is_field_name_available(
82        result: IDatabaseResultSet,
83        field_name: StringView,
84    ) -> bool = [0, SLOT_IS_FIELD_NAME_AVAILABLE] or false;
85
86    /// `long IDatabaseResultSet::getFieldInt(std::size_t)`.
87    ///
88    /// # Safety
89    /// `result` must be a live `IDatabaseResultSet`.
90    #[must_use]
91    pub fn db_result_field_int(
92        result: IDatabaseResultSet,
93        field_index: usize,
94    ) -> i32 = [0, SLOT_GET_FIELD_INT] or 0;
95
96    /// `double IDatabaseResultSet::getFieldFloat(std::size_t)`.
97    ///
98    /// # Safety
99    /// `result` must be a live `IDatabaseResultSet`.
100    #[must_use]
101    pub fn db_result_field_float(
102        result: IDatabaseResultSet,
103        field_index: usize,
104    ) -> f64 = [0, SLOT_GET_FIELD_FLOAT] or 0.0;
105
106    /// `long IDatabaseResultSet::getFieldIntByName(StringView)`.
107    ///
108    /// # Safety
109    /// `result` must be a live `IDatabaseResultSet`.
110    #[must_use]
111    pub fn db_result_field_int_by_name(
112        result: IDatabaseResultSet,
113        field_name: StringView,
114    ) -> i32 = [0, SLOT_GET_FIELD_INT_BY_NAME] or 0;
115
116    /// `double IDatabaseResultSet::getFieldFloatByName(StringView)`.
117    ///
118    /// # Safety
119    /// `result` must be a live `IDatabaseResultSet`.
120    #[must_use]
121    pub fn db_result_field_float_by_name(
122        result: IDatabaseResultSet,
123        field_name: StringView,
124    ) -> f64 = [0, SLOT_GET_FIELD_FLOAT_BY_NAME] or 0.0;
125
126    /// `LegacyDBResult & IDatabaseResultSet::getLegacyDBResult()`.
127    ///
128    /// # Safety
129    /// `result` must be a live `IDatabaseResultSet`.
130    #[must_use]
131    pub fn db_result_legacy_db_result(
132        result: IDatabaseResultSet,
133    ) -> *mut LegacyDBResult = [0, SLOT_GET_LEGACY_DB_RESULT] or std::ptr::null_mut();
134}
135
136/// `StringView IDatabaseResultSet::getFieldName(std::size_t)`.
137///
138/// # Safety
139/// `result` must be a live `IDatabaseResultSet`.
140#[must_use]
141pub unsafe fn db_result_field_name(
142    result: *mut IDatabaseResultSet,
143    field_index: usize,
144) -> Option<String> {
145    let view = call_vtable_small_struct!(
146        result.cast::<u8>(),
147        0,
148        SLOT_GET_FIELD_NAME,
149        StringView,
150        StringView::EMPTY,
151        (usize)(field_index)
152    )?;
153    unsafe { view.to_owned_string() }
154}
155
156/// `StringView IDatabaseResultSet::getFieldString(std::size_t)`.
157///
158/// # Safety
159/// `result` must be a live `IDatabaseResultSet`.
160#[must_use]
161pub unsafe fn db_result_field_string(
162    result: *mut IDatabaseResultSet,
163    field_index: usize,
164) -> Option<String> {
165    let view = call_vtable_small_struct!(
166        result.cast::<u8>(),
167        0,
168        SLOT_GET_FIELD_STRING,
169        StringView,
170        StringView::EMPTY,
171        (usize)(field_index)
172    )?;
173    unsafe { view.to_owned_string() }
174}
175
176/// `StringView IDatabaseResultSet::getFieldStringByName(StringView)`.
177///
178/// # Safety
179/// `result` must be a live `IDatabaseResultSet`.
180#[must_use]
181pub unsafe fn db_result_field_string_by_name(
182    result: *mut IDatabaseResultSet,
183    field_name: StringView,
184) -> Option<String> {
185    let view = call_vtable_small_struct!(
186        result.cast::<u8>(),
187        0,
188        SLOT_GET_FIELD_STRING_BY_NAME,
189        StringView,
190        StringView::EMPTY,
191        (StringView)(field_name)
192    )?;
193    unsafe { view.to_owned_string() }
194}
samp_sdk/omp/generated/db_result.rs

samp_sdk/omp/generated/
db_result.rs
