Struct modio::Query

pub struct Query<T> { /* private fields */ }

Interface for retrieving search results.

Implementations

impl<T: DeserializeOwned + Send> Query<T>

pub async fn first(self) -> Result<Option<T>>

Returns the first search result.

pub async fn first_page(self) -> Result<Vec<T>>

Returns the first search result page.

pub async fn collect(self) -> Result<Vec<T>>

Returns the complete search result list.

pub async fn iter(self) -> Result<impl Stream<Item = Result<T>>>

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

use futures_util::TryStreamExt;
use modio::filter::prelude::*;
use modio::types::id::Id;

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);
}

pub async fn paged(self) -> Result<impl Stream<Item = Result<Page<T>>>>

Provides a stream over all search result pages.

Example

use futures_util::TryStreamExt;
use modio::filter::prelude::*;
use modio::types::id::Id;

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);
    }
}