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 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403
// Copyright (c) 2020 rust-mysql-simple contributors
//
// Licensed under the Apache License, Version 2.0
// <LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0> or the MIT
// license <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. All files in the project carrying such notice may not be copied,
// modified, or distributed except according to those terms.
pub use mysql_common::proto::{Binary, Text};
use mysql_common::{io::ParseBuf, packets::OkPacket, row::RowDeserializer, value::ServerSide};
use std::{borrow::Cow, marker::PhantomData, sync::Arc};
use crate::{conn::ConnMut, Column, Conn, Error, Result, Row};
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum Or<A, B> {
A(A),
B(B),
}
/// Result set kind.
pub trait Protocol: 'static + Send + Sync {
fn next(conn: &mut Conn, columns: Arc<[Column]>) -> Result<Option<Row>>;
}
impl Protocol for Text {
fn next(conn: &mut Conn, columns: Arc<[Column]>) -> Result<Option<Row>> {
match conn.next_row_packet()? {
Some(pld) => {
let row = ParseBuf(&pld).parse::<RowDeserializer<(), Text>>(columns)?;
Ok(Some(row.into()))
}
None => Ok(None),
}
}
}
impl Protocol for Binary {
fn next(conn: &mut Conn, columns: Arc<[Column]>) -> Result<Option<Row>> {
match conn.next_row_packet()? {
Some(pld) => {
let row = ParseBuf(&pld).parse::<RowDeserializer<ServerSide, Binary>>(columns)?;
Ok(Some(row.into()))
}
None => Ok(None),
}
}
}
/// State of a result set iterator.
#[derive(Debug)]
enum SetIteratorState {
/// Iterator is in a non-empty set.
InSet(Arc<[Column]>),
/// Iterator is in an empty set.
InEmptySet(OkPacket<'static>),
/// Iterator is in an errored result set.
Errored(Error),
/// Next result set isn't handled.
OnBoundary,
/// No more result sets.
Done,
}
impl SetIteratorState {
fn ok_packet(&self) -> Option<&OkPacket<'_>> {
if let Self::InEmptySet(ref ok) = self {
Some(ok)
} else {
None
}
}
fn columns(&self) -> Option<&Arc<[Column]>> {
if let Self::InSet(ref cols) = self {
Some(cols)
} else {
None
}
}
}
impl From<Vec<Column>> for SetIteratorState {
fn from(columns: Vec<Column>) -> Self {
Self::InSet(columns.into())
}
}
impl From<OkPacket<'static>> for SetIteratorState {
fn from(ok_packet: OkPacket<'static>) -> Self {
Self::InEmptySet(ok_packet)
}
}
impl From<Error> for SetIteratorState {
fn from(err: Error) -> Self {
Self::Errored(err)
}
}
impl From<Or<Vec<Column>, OkPacket<'static>>> for SetIteratorState {
fn from(or: Or<Vec<Column>, OkPacket<'static>>) -> Self {
match or {
Or::A(cols) => Self::from(cols),
Or::B(ok) => Self::from(ok),
}
}
}
/// Response to a query or statement execution.
///
/// It is an iterator:
/// * over result sets (via `Self::current_set`)
/// * over rows of a current result set (via `Iterator` impl)
#[derive(Debug)]
pub struct QueryResult<'c, 't, 'tc, T: crate::prelude::Protocol> {
conn: ConnMut<'c, 't, 'tc>,
state: SetIteratorState,
set_index: usize,
protocol: PhantomData<T>,
}
impl<'c, 't, 'tc, T: crate::prelude::Protocol> QueryResult<'c, 't, 'tc, T> {
fn from_state(
conn: ConnMut<'c, 't, 'tc>,
state: SetIteratorState,
) -> QueryResult<'c, 't, 'tc, T> {
QueryResult {
conn,
state,
set_index: 0,
protocol: PhantomData,
}
}
pub(crate) fn new(
conn: ConnMut<'c, 't, 'tc>,
meta: Or<Vec<Column>, OkPacket<'static>>,
) -> QueryResult<'c, 't, 'tc, T> {
Self::from_state(conn, meta.into())
}
/// Updates state with the next result set, if any.
///
/// Returns `false` if there is no next result set.
///
/// **Requires:** `self.state == OnBoundary`
fn handle_next(&mut self) {
debug_assert!(
matches!(self.state, SetIteratorState::OnBoundary),
"self.state != OnBoundary"
);
if self.conn.more_results_exists() {
match self.conn.handle_result_set() {
Ok(meta) => self.state = meta.into(),
Err(err) => self.state = err.into(),
}
self.set_index += 1;
} else {
self.state = SetIteratorState::Done;
}
}
/// Returns an iterator over the current result set.
#[deprecated = "Please use QueryResult::iter"]
pub fn next_set<'d>(&'d mut self) -> Option<ResultSet<'c, 't, 'tc, 'd, T>> {
self.iter()
}
/// Returns an iterator over the current result set.
///
/// The returned iterator will be consumed either by the caller
/// or implicitly by the `ResultSet::drop`. This operation
/// will advance `self` to the next result set (if any).
///
/// The following code describes the behavior:
///
/// ```rust
/// # mysql::doctest_wrapper!(__result, {
/// # use mysql::*;
/// # use mysql::prelude::*;
/// # let pool = Pool::new(get_opts())?;
/// # let mut conn = pool.get_conn()?;
/// # conn.query_drop("CREATE TEMPORARY TABLE mysql.tbl(id INT NOT NULL PRIMARY KEY)")?;
///
/// let mut query_result = conn.query_iter("\
/// INSERT INTO mysql.tbl (id) VALUES (3, 4);\
/// SELECT * FROM mysql.tbl;
/// UPDATE mysql.tbl SET id = id + 1;")?;
///
/// // query_result is on the first result set at the moment
/// {
/// assert_eq!(query_result.affected_rows(), 2);
/// assert_eq!(query_result.last_insert_id(), Some(4));
///
/// let first_result_set = query_result.iter().unwrap();
/// assert_eq!(first_result_set.affected_rows(), 2);
/// assert_eq!(first_result_set.last_insert_id(), Some(4));
/// }
///
/// // the first result set is now dropped, so query_result is on the second result set
/// {
/// assert_eq!(query_result.affected_rows(), 0);
/// assert_eq!(query_result.last_insert_id(), None);
///
/// let mut second_result_set = query_result.iter().unwrap();
///
/// let first_row = second_result_set.next().unwrap().unwrap();
/// assert_eq!(from_row::<u8>(first_row), 3_u8);
/// let second_row = second_result_set.next().unwrap().unwrap();
/// assert_eq!(from_row::<u8>(second_row), 4_u8);
///
/// assert!(second_result_set.next().is_none());
///
/// // second_result_set is consumed but still represents the second result set
/// assert_eq!(second_result_set.affected_rows(), 0);
/// }
///
/// // the second result set is now dropped, so query_result is on the third result set
/// assert_eq!(query_result.affected_rows(), 2);
///
/// // QueryResult::drop simply does the following:
/// while query_result.iter().is_some() {}
/// # });
/// ```
pub fn iter<'d>(&'d mut self) -> Option<ResultSet<'c, 't, 'tc, 'd, T>> {
use SetIteratorState::*;
if let OnBoundary | Done = &self.state {
debug_assert!(
!self.conn.more_results_exists(),
"the next state must be handled by the Iterator::next"
);
None
} else {
Some(ResultSet {
set_index: self.set_index,
inner: self,
})
}
}
/// Returns the number of affected rows for the current result set.
pub fn affected_rows(&self) -> u64 {
self.state
.ok_packet()
.map(|ok| ok.affected_rows())
.unwrap_or_default()
}
/// Returns the last insert id for the current result set.
pub fn last_insert_id(&self) -> Option<u64> {
self.state
.ok_packet()
.map(|ok| ok.last_insert_id())
.unwrap_or_default()
}
/// Returns the warnings count for the current result set.
pub fn warnings(&self) -> u16 {
self.state
.ok_packet()
.map(|ok| ok.warnings())
.unwrap_or_default()
}
/// [Info] for the current result set.
///
/// Will be empty if not defined.
///
/// [Info]: http://dev.mysql.com/doc/internals/en/packet-OK_Packet.html
pub fn info_ref(&self) -> &[u8] {
self.state
.ok_packet()
.and_then(|ok| ok.info_ref())
.unwrap_or_default()
}
/// [Info] for the current result set.
///
/// Will be empty if not defined.
///
/// [Info]: http://dev.mysql.com/doc/internals/en/packet-OK_Packet.html
pub fn info_str(&self) -> Cow<str> {
self.state
.ok_packet()
.and_then(|ok| ok.info_str())
.unwrap_or_else(|| "".into())
}
/// Returns columns of the current result rest.
pub fn columns(&self) -> SetColumns {
SetColumns {
inner: self.state.columns().map(Into::into),
}
}
}
impl<'c, 't, 'tc, T: crate::prelude::Protocol> Drop for QueryResult<'c, 't, 'tc, T> {
fn drop(&mut self) {
while self.iter().is_some() {}
}
}
#[derive(Debug)]
pub struct ResultSet<'a, 'b, 'c, 'd, T: crate::prelude::Protocol> {
set_index: usize,
inner: &'d mut QueryResult<'a, 'b, 'c, T>,
}
impl<'a, 'b, 'c, T: crate::prelude::Protocol> std::ops::Deref for ResultSet<'a, 'b, 'c, '_, T> {
type Target = QueryResult<'a, 'b, 'c, T>;
fn deref(&self) -> &Self::Target {
&*self.inner
}
}
impl<T: crate::prelude::Protocol> Iterator for ResultSet<'_, '_, '_, '_, T> {
type Item = Result<Row>;
fn next(&mut self) -> Option<Self::Item> {
if self.set_index == self.inner.set_index {
self.inner.next()
} else {
None
}
}
}
impl<T: crate::prelude::Protocol> Iterator for QueryResult<'_, '_, '_, T> {
type Item = Result<Row>;
fn next(&mut self) -> Option<Self::Item> {
use SetIteratorState::*;
let state = std::mem::replace(&mut self.state, OnBoundary);
match state {
InSet(cols) => match T::next(&mut self.conn, cols.clone()) {
Ok(Some(row)) => {
self.state = InSet(cols);
Some(Ok(row))
}
Ok(None) => {
self.handle_next();
None
}
Err(e) => {
self.handle_next();
Some(Err(e))
}
},
InEmptySet(_) => {
self.handle_next();
None
}
Errored(err) => {
self.handle_next();
Some(Err(err))
}
OnBoundary => None,
Done => {
self.state = Done;
None
}
}
}
}
impl<T: crate::prelude::Protocol> Drop for ResultSet<'_, '_, '_, '_, T> {
fn drop(&mut self) {
while self.next().is_some() {}
}
}
#[derive(Debug, Clone, PartialEq)]
pub struct SetColumns<'a> {
inner: Option<&'a Arc<[Column]>>,
}
impl<'a> SetColumns<'a> {
/// Returns an index of a column by its name.
pub fn column_index<U: AsRef<str>>(&self, name: U) -> Option<usize> {
let name = name.as_ref().as_bytes();
self.inner
.as_ref()
.and_then(|cols| cols.iter().position(|col| col.name_ref() == name))
}
}
impl AsRef<[Column]> for SetColumns<'_> {
fn as_ref(&self) -> &[Column] {
self.inner
.as_ref()
.map(|cols| &(*cols)[..])
.unwrap_or(&[][..])
}
}