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
// Copyright (c) 2021 mysql_async developers.
//
// 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.
use std::any::type_name;
use std::borrow::Cow;
use std::sync::Arc;
use std::task::Poll;
use std::{fmt, marker::PhantomData};
use futures_core::FusedStream;
use futures_core::{future::BoxFuture, Stream};
use futures_util::FutureExt;
use mysql_common::packets::{Column, OkPacket};
use crate::{
conn::PendingResult,
prelude::{FromRow, Protocol},
QueryResult, Row,
};
enum CowMut<'r, 'a: 'r, 't: 'a, P> {
Borrowed(&'r mut QueryResult<'a, 't, P>),
Owned(QueryResult<'a, 't, P>),
}
impl<'r, 'a: 'r, 't: 'a, P> fmt::Debug for CowMut<'r, 'a, 't, P> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
Self::Borrowed(arg0) => f.debug_tuple("Borrowed").field(arg0).finish(),
Self::Owned(arg0) => f.debug_tuple("Owned").field(arg0).finish(),
}
}
}
impl<'r, 'a: 'r, 't: 'a, P> AsMut<QueryResult<'a, 't, P>> for CowMut<'r, 'a, 't, P> {
fn as_mut(&mut self) -> &mut QueryResult<'a, 't, P> {
match self {
CowMut::Borrowed(q) => q,
CowMut::Owned(q) => q,
}
}
}
enum ResultSetStreamState<'r, 'a: 'r, 't: 'a, P> {
Idle(CowMut<'r, 'a, 't, P>),
NextFut(BoxFuture<'r, (crate::Result<Option<Row>>, CowMut<'r, 'a, 't, P>)>),
}
impl<'r, 'a: 'r, 't: 'a, P> fmt::Debug for ResultSetStreamState<'r, 'a, 't, P> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
Self::Idle(arg0) => f.debug_tuple("Idle").field(arg0).finish(),
Self::NextFut(_arg0) => f
.debug_tuple("NextFut")
.field(&type_name::<
BoxFuture<'r, (crate::Result<Option<Row>>, CowMut<'r, 'a, 't, P>)>,
>())
.finish(),
}
}
}
#[derive(Debug)]
/// Rows stream for a single result set.
pub struct ResultSetStream<'r, 'a: 'r, 't: 'a, T, P> {
query_result: Option<ResultSetStreamState<'r, 'a, 't, P>>,
ok_packet: Option<OkPacket<'static>>,
columns: Arc<[Column]>,
__from_row_type: PhantomData<T>,
}
impl<'r, 'a: 'r, 't: 'a, T, P> FusedStream for ResultSetStream<'r, 'a, 't, T, P>
where
P: Protocol + Unpin,
T: FromRow + Unpin + Send + 'static,
{
fn is_terminated(&self) -> bool {
self.query_result.is_none()
}
}
impl<'r, 'a: 'r, 't: 'a, T, P> ResultSetStream<'r, 'a, 't, T, P> {
/// See [`Conn::last_insert_id`][1].
///
/// [1]: crate::Conn::last_insert_id
pub fn last_insert_id(&self) -> Option<u64> {
self.ok_packet.as_ref().and_then(|ok| ok.last_insert_id())
}
/// See [`Conn::affected_rows`][1].
///
/// [1]: crate::Conn::affected_rows
pub fn affected_rows(&self) -> u64 {
self.ok_packet
.as_ref()
.map(|ok| ok.affected_rows())
.unwrap_or_default()
}
/// See [`QueryResult::columns_ref`].
pub fn columns_ref(&self) -> &[Column] {
&self.columns[..]
}
/// See [`QueryResult::columns`].
pub fn columns(&self) -> Arc<[Column]> {
self.columns.clone()
}
/// See [`Conn::info`][1].
///
/// [1]: crate::Conn::info
pub fn info(&self) -> Cow<'_, str> {
self.ok_packet
.as_ref()
.and_then(|ok| ok.info_str())
.unwrap_or_default()
}
/// See [`Conn::get_warnings`][1].
///
/// [1]: crate::Conn::get_warnings
pub fn get_warnings(&self) -> u16 {
self.ok_packet
.as_ref()
.map(|ok| ok.warnings())
.unwrap_or_default()
}
/// Returns an `OkPacket` corresponding to this result set.
///
/// Will be `None` if there is no OK packet (result set contains an error).
pub fn ok_packet(&self) -> Option<&OkPacket<'static>> {
self.ok_packet.as_ref()
}
}
impl<'r, 'a: 'r, 't: 'a, T, P> Stream for ResultSetStream<'r, 'a, 't, T, P>
where
P: Protocol + Unpin,
T: FromRow + Unpin + Send + 'static,
{
type Item = crate::Result<T>;
fn poll_next(
self: std::pin::Pin<&mut Self>,
cx: &mut std::task::Context<'_>,
) -> Poll<Option<Self::Item>> {
let this = self.get_mut();
loop {
let columns = this.columns.clone();
match this.query_result.take() {
Some(ResultSetStreamState::Idle(mut query_result)) => {
let fut = Box::pin(async move {
let row = query_result.as_mut().next_row_or_next_set2(columns).await;
(row, query_result)
});
this.query_result = Some(ResultSetStreamState::NextFut(fut));
}
Some(ResultSetStreamState::NextFut(mut fut)) => match fut.poll_unpin(cx) {
Poll::Ready((row, query_result)) => match row {
Ok(Some(row)) => {
this.query_result = Some(ResultSetStreamState::Idle(query_result));
return Poll::Ready(Some(Ok(crate::from_row(row))));
}
Ok(None) => return Poll::Ready(None),
Err(err) => return Poll::Ready(Some(Err(err))),
},
Poll::Pending => {
this.query_result = Some(ResultSetStreamState::NextFut(fut));
return Poll::Pending;
}
},
None => return Poll::Ready(None),
}
}
}
}
impl<'a, 't: 'a, P> QueryResult<'a, 't, P>
where
P: Protocol + Unpin,
{
async fn setup_stream(
&mut self,
) -> crate::Result<Option<(Option<OkPacket<'static>>, Arc<[Column]>)>> {
match self.conn.use_pending_result()? {
Some(PendingResult::Taken(meta)) => {
let meta = (*meta).clone();
self.skip_taken(meta).await?;
}
Some(_) => (),
None => return Ok(None),
}
let ok_packet = self.conn.last_ok_packet().cloned();
let columns = match self.conn.take_pending_result()? {
Some(meta) => meta.columns().clone(),
None => return Ok(None),
};
Ok(Some((ok_packet, columns)))
}
/// Returns a [`Stream`] for the current result set.
///
/// The returned stream satisfies [`futures_util::TryStream`],
/// so you can use [`futures_util::TryStreamExt`] functions on it.
///
/// # Behavior
///
/// ## Conversion
///
/// This stream will convert each row into `T` using [`FromRow`] implementation.
/// If the row type is unknown please use the [`Row`] type for `T`
/// to make this conversion infallible.
///
/// ## Consumption
///
/// The call to [`QueryResult::stream`] entails the consumption of the current result set,
/// practically this means that the second call to [`QueryResult::stream`] will return
/// the next result set stream even if the stream returned from the first call wasn't
/// explicitly consumed:
///
/// ```rust
/// # use mysql_async::test_misc::get_opts;
/// # #[tokio::main]
/// # async fn main() -> mysql_async::Result<()> {
/// # use mysql_async::*;
/// # use mysql_async::prelude::*;
/// # use futures_util::StreamExt;
/// let mut conn = Conn::new(get_opts()).await?;
///
/// // This query result will contain two result sets.
/// let mut result = conn.query_iter("SELECT 1; SELECT 2;").await?;
///
/// // The first result set stream is dropped here without being consumed,
/// let _ = result.stream::<u8>().await?;
/// // so it will be implicitly consumed here.
/// let mut stream = result.stream::<u8>().await?.expect("the second result set must be here");
/// assert_eq!(2_u8, stream.next().await.unwrap()?);
///
/// # drop(stream); drop(result); conn.disconnect().await }
/// ```
///
/// ## Errors
///
/// Note, that [`QueryResult::stream`] may error if:
///
/// - current result set contains an error,
/// - previously unconsumed result set stream contained an error.
///
/// ```rust
/// # use mysql_async::test_misc::get_opts;
/// # #[tokio::main]
/// # async fn main() -> mysql_async::Result<()> {
/// # use mysql_async::*;
/// # use mysql_async::prelude::*;
/// # use futures_util::StreamExt;
/// let mut conn = Conn::new(get_opts()).await?;
///
/// // The second result set of this query will contain an error.
/// let mut result = conn.query_iter("SELECT 1; SELECT FOO(); SELECT 2;").await?;
///
/// // First result set stream is dropped here without being consumed,
/// let _ = result.stream::<Row>().await?;
/// // so it will be implicitly consumed on the second call to `QueryResult::stream`
/// // that will error complaining about unknown FOO
/// assert!(result.stream::<Row>().await.unwrap_err().to_string().contains("FOO"));
///
/// # drop(result); conn.disconnect().await }
/// ```
pub fn stream<'r, T: Unpin + FromRow + Send + 'static>(
&'r mut self,
) -> BoxFuture<'r, crate::Result<Option<ResultSetStream<'r, 'a, 't, T, P>>>> {
async move {
Ok(self
.setup_stream()
.await?
.map(
move |(ok_packet, columns)| ResultSetStream::<'r, 'a, 't, T, P> {
ok_packet,
columns,
query_result: Some(ResultSetStreamState::Idle(CowMut::Borrowed(self))),
__from_row_type: PhantomData,
},
))
}
.boxed()
}
/// Owned version of the [`QueryResult::stream`].
///
/// Returned stream will stop iteration on the first result set boundary.
///
/// See also [`Query::stream`][query_stream], [`Queryable::query_stream`][queryable_query_stream],
/// [`Queryable::exec_stream`][queryable_exec_stream].
///
/// The following example uses the [`Query::stream`][query_stream] function
/// that is based on the [`QueryResult::stream_and_drop`]:
///
/// ```rust
/// # use mysql_async::test_misc::get_opts;
/// # #[tokio::main]
/// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
/// # use mysql_async::*;
/// # use mysql_async::prelude::*;
/// # use futures_util::TryStreamExt;
/// let pool = Pool::new(get_opts());
/// let mut conn = pool.get_conn().await?;
///
/// // This example uses the `Query::stream` function that is based on `QueryResult::stream_and_drop`:
/// let mut stream = "SELECT 1 UNION ALL SELECT 2".stream::<u8, _>(&mut conn).await?;
/// let rows = stream.try_collect::<Vec<_>>().await.unwrap();
/// assert_eq!(vec![1, 2], rows);
///
/// // Only the first result set will go into the stream:
/// let mut stream = r"
/// SELECT 'foo' UNION ALL SELECT 'bar';
/// SELECT 'baz' UNION ALL SELECT 'quux';".stream::<String, _>(&mut conn).await?;
/// let rows = stream.try_collect::<Vec<_>>().await.unwrap();
/// assert_eq!(vec!["foo".to_owned(), "bar".to_owned()], rows);
///
/// // We can also build a `'static` stream by giving away the connection:
/// let stream = "SELECT 2 UNION ALL SELECT 3".stream::<u8, _>(conn).await?;
/// // `tokio::spawn` requires `'static`
/// let handle = tokio::spawn(async move {
/// stream.try_collect::<Vec<_>>().await.unwrap()
/// });
/// assert_eq!(vec![2, 3], handle.await?);
///
/// # Ok(()) }
/// ```
///
/// [queryable_query_stream]: crate::prelude::Queryable::query_stream
/// [queryable_exec_stream]: crate::prelude::Queryable::exec_stream
/// [query_stream]: crate::prelude::Query::stream
pub fn stream_and_drop<T: Unpin + FromRow + Send + 'static>(
mut self,
) -> BoxFuture<'a, crate::Result<Option<ResultSetStream<'a, 'a, 't, T, P>>>> {
async move {
Ok(self
.setup_stream()
.await?
.map(|(ok_packet, columns)| ResultSetStream::<'a, 'a, 't, T, P> {
ok_packet,
columns,
query_result: Some(ResultSetStreamState::Idle(CowMut::Owned(self))),
__from_row_type: PhantomData,
}))
}
.boxed()
}
}