odbc-api 24.1.0

Write ODBC Applications in (mostly) safe Rust.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

use odbc_sys::{Handle, HandleType};

/// Provides access to the raw underlying ODBC handle. This trait is implemented for environment,
/// connection and statement handles. [`Self::handle_type`] allows to determine the type of the
/// handle at runtime. Yet, this information is not in the type system. This is useful for
/// operations, which must work with all handle types. E.g. fetching diagnostics.
///
/// # Safety
///
/// The handle provided by `as_handle` must be valid and match the type returned by `handle_type`.
pub unsafe trait AnyHandle {
    /// The raw underlying ODBC handle used to talk to the ODBC C API. The handle must be valid.
    fn as_handle(&self) -> Handle;

    /// The type of the ODBC handle returned by `as_handle`. This is a method rather than a constant
    /// in order to make the type object safe.
    fn handle_type(&self) -> HandleType;
}