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
use std::marker::PhantomData;
use std::pin::Pin;
use std::task::{Context, Poll};
use futures_util::future::Either;
use futures_util::{stream, Stream, StreamExt, TryStreamExt};
use pin_project_lite::pin_project;
use serde::de::DeserializeOwned;
use crate::filter::Filter;
use crate::routing::Route;
use crate::types::List;
use crate::{Modio, Result};
/// Interface for retrieving search results.
pub struct Query<T> {
modio: Modio,
route: Route,
filter: Filter,
phantom: PhantomData<T>,
}
impl<T> Query<T> {
pub(crate) fn new(modio: Modio, route: Route, filter: Filter) -> Self {
Self {
modio,
route,
filter,
phantom: PhantomData,
}
}
}
impl<T: DeserializeOwned + Send> Query<T> {
/// Returns the first search result.
pub async fn first(mut self) -> Result<Option<T>> {
self.filter = self.filter.limit(1);
let list = self.first_page().await;
list.map(|l| l.into_iter().next())
}
/// Returns the first search result page.
pub async fn first_page(self) -> Result<Vec<T>> {
let list = self.paged().await?.map_ok(|p| p.0.data).try_next().await;
list.map(Option::unwrap_or_default)
}
/// Returns the complete search result list.
pub async fn collect(self) -> Result<Vec<T>> {
self.paged().await?.map_ok(|p| p.0.data).try_concat().await
}
/// Provides a stream over all search result items.
///
/// Beware that a `Filter::with_limit` will NOT limit the number of items returned
/// by the stream, but limits the page size for the underlying API requests.
///
/// # Example
/// ```no_run
/// use futures_util::TryStreamExt;
/// use modio::filter::prelude::*;
/// use modio::types::id::Id;
///
/// # use modio::{Credentials, Modio, Result};
/// #
/// # async fn run() -> Result<()> {
/// # let modio = Modio::new(Credentials::new("apikey"))?;
/// let filter = Fulltext::eq("soldier");
/// let mut st = modio.game(Id::new(51)).mods().search(filter).iter().await?;
///
/// // Stream of `Mod`
/// while let Some(mod_) = st.try_next().await? {
/// println!("{}. {}", mod_.id, mod_.name);
/// }
///
/// use futures_util::StreamExt;
///
/// // Retrieve the first 10 mods. (Default page size is `100`.)
/// let filter = Fulltext::eq("tftd") + with_limit(10);
/// let st = modio.game(Id::new(51)).mods().search(filter).iter().await?;
/// let mut st = st.take(10);
///
/// // Stream of `Mod`
/// while let Some(mod_) = st.try_next().await? {
/// println!("{}. {}", mod_.id, mod_.name);
/// }
/// # Ok(())
/// # }
/// ```
#[allow(clippy::iter_not_returning_iterator)]
pub async fn iter(self) -> Result<impl Stream<Item = Result<T>>> {
let (st, (total, _)) = stream(self.modio, self.route, self.filter).await?;
let st = st
.map_ok(|list| stream::iter(list.into_iter().map(Ok)))
.try_flatten();
Ok(Box::pin(ResultStream::new(total as usize, st)))
}
/// Provides a stream over all search result pages.
///
/// # Example
/// ```no_run
/// use futures_util::TryStreamExt;
/// use modio::filter::prelude::*;
/// use modio::types::id::Id;
///
/// # use modio::{Credentials, Modio, Result};
/// #
/// # async fn run() -> Result<()> {
/// # let modio = Modio::new(Credentials::new("apikey"))?;
/// let filter = Fulltext::eq("tftd").limit(10);
/// let mut st = modio
/// .game(Id::new(51))
/// .mods()
/// .search(filter)
/// .paged()
/// .await?;
///
/// // Stream of paged results `Page<Mod>` with page size = 10
/// while let Some(page) = st.try_next().await? {
/// println!("Page {}/{}", page.current(), page.page_count());
/// for item in page {
/// println!(" {}. {}", item.id, item.name);
/// }
/// }
/// # Ok(())
/// # }
/// ```
pub async fn paged(self) -> Result<impl Stream<Item = Result<Page<T>>>> {
let (st, (total, limit)) = stream(self.modio, self.route, self.filter).await?;
let size_hint = if total == 0 {
0
} else {
(total - 1) / limit + 1
};
Ok(Box::pin(ResultStream::new(size_hint as usize, st)))
}
}
async fn stream<T>(
modio: Modio,
route: Route,
filter: Filter,
) -> Result<(impl Stream<Item = Result<Page<T>>>, (u32, u32))>
where
T: DeserializeOwned + Send,
{
struct State {
offset: u32,
limit: u32,
remaining: u32,
}
let list = modio
.request(route)
.query(&filter)
.send::<List<T>>()
.await?;
let state = State {
offset: list.offset,
limit: list.limit,
remaining: list.total - list.count,
};
let initial = (modio, route, filter, state);
let stats = (list.total, list.limit);
if list.total == 0 {
return Ok((Either::Left(stream::empty()), stats));
}
let first = stream::once(async { Ok::<_, crate::Error>(Page(list)) });
let others = stream::try_unfold(initial, |(modio, route, filter, state)| async move {
if let State { remaining: 0, .. } = state {
return Ok(None);
}
let filter = filter.offset((state.offset + state.limit) as usize);
let remaining = state.remaining;
let list = modio
.request(route)
.query(&filter)
.send::<List<T>>()
.await?;
let state = (
modio,
route,
filter,
State {
offset: list.offset,
limit: list.limit,
remaining: remaining - list.count,
},
);
Ok(Some((Page(list), state)))
});
Ok((Either::Right(first.chain(others)), stats))
}
/// A `Page` returned by the [`Query::paged`] stream for a search result.
pub struct Page<T>(List<T>);
impl<T> Page<T> {
pub fn data(&self) -> &Vec<T> {
&self.0.data
}
pub fn into_data(self) -> Vec<T> {
self.0.data
}
/// Returns the current page number.
pub fn current(&self) -> usize {
self.0.offset as usize / self.page_size() + 1
}
/// Returns the number of pages.
pub fn page_count(&self) -> usize {
(self.total() - 1) / self.page_size() + 1
}
/// Returns the size of a page.
pub fn page_size(&self) -> usize {
self.0.limit as usize
}
/// Returns the total number of the search result.
pub fn total(&self) -> usize {
self.0.total as usize
}
}
// Impl IntoIterator & Deref for Page<T> {{{
impl<T> std::ops::Deref for Page<T> {
type Target = Vec<T>;
fn deref(&self) -> &Self::Target {
&self.0.data
}
}
impl<'a, T> std::iter::IntoIterator for &'a Page<T> {
type Item = &'a T;
type IntoIter = std::slice::Iter<'a, T>;
fn into_iter(self) -> std::slice::Iter<'a, T> {
self.0.data.iter()
}
}
impl<T> std::iter::IntoIterator for Page<T> {
type Item = T;
type IntoIter = std::vec::IntoIter<T>;
fn into_iter(self) -> std::vec::IntoIter<T> {
self.0.data.into_iter()
}
}
// }}}
pin_project! {
struct ResultStream<St> {
total: usize,
#[pin]
stream: St,
}
}
impl<St: Stream> ResultStream<St> {
fn new(total: usize, stream: St) -> ResultStream<St> {
Self { total, stream }
}
}
impl<St: Stream> Stream for ResultStream<St> {
type Item = St::Item;
fn size_hint(&self) -> (usize, Option<usize>) {
(self.total, None)
}
fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
self.project().stream.poll_next(cx)
}
}
// vim: fdm=marker