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
use crate::result_set::{MySqlColumn, MySqlTypeInfo};
use either::Either;
use std::convert::identity;
/// Provides extended information on a statement.
///
/// Returned from [`Executor::describe`].
///
/// The query macros (e.g., `query!`, `query_as!`, etc.) use the information here to validate
/// output and parameter types; and, generate an anonymous record.
#[derive(Debug)]
#[doc(hidden)]
pub struct Describe {
pub(crate) columns: Vec<MySqlColumn>,
pub(crate) parameters: Option<Either<Vec<MySqlTypeInfo>, usize>>,
pub(crate) nullable: Vec<Option<bool>>,
}
impl Describe {
/// Gets all columns in this statement.
pub fn columns(&self) -> &[MySqlColumn] {
&self.columns
}
/// Gets the column information at `index`.
///
/// Panics if `index` is out of bounds.
pub fn column(&self, index: usize) -> &MySqlColumn {
&self.columns[index]
}
/// Gets the available information for parameters in this statement.
///
/// Some drivers may return more or less than others. As an example, **PostgreSQL** will
/// return `Some(Either::Left(_))` with a full list of type information for each parameter.
/// However, **MSSQL** will return `None` as there is no information available.
pub fn parameters(&self) -> Option<Either<&[MySqlTypeInfo], usize>> {
self.parameters.as_ref().map(|p| match p {
Either::Left(params) => Either::Left(&**params),
Either::Right(count) => Either::Right(*count),
})
}
/// Gets whether a column may be `NULL`, if this information is available.
pub fn nullable(&self, column: usize) -> Option<bool> {
self.nullable.get(column).copied().and_then(identity)
}
}