rs-odbc 0.2.0

Minimal safe Rust implementation of ODBC
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74

use rs_odbc_derive::odbc_type;

/// Each function in ODBC returns a code, known as its return code, which indicates the
/// overall success or failure of the function. Program logic is generally based on return
/// codes.
///
/// # Documentation
/// https://docs.microsoft.com/en-us/sql/odbc/reference/develop-app/return-codes-odbc
/// https://github.com/microsoft/ODBC-Specification/blob/ODBC%204.0.md
#[must_use]
#[odbc_type(SQLSMALLINT)]
pub struct SQLRETURN;

/// Function completed successfully. The application calls SQLGetDiagField to retrieve
/// additional information from the header record.
pub const SQL_SUCCESS: SQLRETURN = SQLRETURN(0);

/// Function completed successfully, possibly with a nonfatal error (warning). The
/// application calls SQLGetDiagRec or SQLGetDiagField to retrieve additional
/// information.
pub const SQL_SUCCESS_WITH_INFO: SQLRETURN = SQLRETURN(1);

/// Function failed. The application calls SQLGetDiagRec or SQLGetDiagField to
/// retrieve additional information. The contents of any output arguments to the
/// function are undefined.
pub const SQL_ERROR: SQLRETURN = SQLRETURN(-1);

// TODO: Can this error occur?
/// Function failed due to an invalid environment, connection, statement, or
/// descriptor handle. This indicates a programming error. No additional information
/// is available from SQLGetDiagRec or SQLGetDiagField. This code is returned only
/// when the handle is a null pointer or is the wrong type, such as when a statement
/// handle is passed for an argument that requires a connection handle.
pub const SQL_INVALID_HANDLE: SQLRETURN = SQLRETURN(-2);

/// No more data was available. The application calls SQLGetDiagRec or SQLGetDiagField
/// to retrieve additional information. One or more driver-defined status records in
/// class 02xxx may be returned. Note:  In ODBC 2.x, this return code was named
/// SQL_NO_DATA_FOUND.
pub const SQL_NO_DATA: SQLRETURN = SQLRETURN(100);

/// More data is needed, such as when parameter data is sent at execution time or
/// additional connection information is required. The application calls SQLGetDiagRec
/// or SQLGetDiagField to retrieve additional information, if any.
pub const SQL_NEED_DATA: SQLRETURN = SQLRETURN(99);

/// A function that was started asynchronously is still executing. The application
/// calls SQLGetDiagRec or SQLGetDiagField to retrieve additional information, if any.
pub const SQL_STILL_EXECUTING: SQLRETURN = SQLRETURN(2);

/// Indicates that there are streamed output parameters available for the next set of
/// parameters to retrieve.
#[cfg(feature = "v3_8")]
pub const SQL_PARAM_DATA_AVAILABLE: SQLRETURN = SQLRETURN(101);

/// Signals data-at-fetch columns are available.
#[cfg(feature = "v4")]
pub const SQL_DATA_AVAILABLE: SQLRETURN = SQLRETURN(102);

/// The descriptor is changed by the driver when reading a column.
#[cfg(feature = "v4")]
pub const SQL_METADATA_CHANGED: SQLRETURN = SQLRETURN(103);

/// The driver does not know how much additional data is to be written.
#[cfg(feature = "v4")]
pub const SQL_MORE_DATA: SQLRETURN = SQLRETURN(104);

#[allow(non_snake_case)]
pub fn SQL_SUCCEEDED<T: Into<SQLRETURN>>(ret: T) -> bool {
    match ret.into() {
        SQL_SUCCESS | SQL_SUCCESS_WITH_INFO => true,
        _ => false,
    }
}