Struct scryfall::card_searcher::SearchBuilder

pub struct SearchBuilder { /* fields omitted */ }

A search builder for constructing a Search for scryfall. The various parameters that can be passed to this struct are defined in this module.

A search is composed of settings and params.

Settings

The in depth documentation for the settings can be found here

• with_unique_strategy: The strategy used to reduce duplicates. (default: See UniqueStrategy)
• sorting_by: The order in which results appear. (default: See SortMethod)
• with_sort_direction: The sorting direction. (default: See SortDirection)
• on_page: The page to start at. (default: 1)
• including_extras: Whether to include extras. (default: false)
• including_multilingual: Whether to include multilingual cards. (default: false)
• including_variations: Whether to include variations. (default: false)

Parameters

Parameters are filters to provide to the search to reduce the cards returned.

The official documentation for the parameters can be found here

Methods

impl SearchBuilder

pub fn new() -> Self

Create a new search builder with the default values.

pub fn with_unique_strategy(&mut self, strat: UniqueStrategy) -> &mut Self

Change the unique strategy to be used to remove repeated cards.

pub fn sorting_by(&mut self, method: SortMethod) -> &mut Self

Change the sorting method used for the results.

pub fn with_sort_direction(&mut self, dir: SortDirection) -> &mut Self

Change the direction in which things are sorted.

pub fn including_extras(&mut self) -> &mut Self

Enable the inclusion of extras.

pub fn including_multilingual(&mut self) -> &mut Self

Enable the inclusion of multilingual cards.

pub fn including_variations(&mut self) -> &mut Self

Enable the inclusion of variations on cards.

pub fn on_page(&mut self, page: usize) -> &mut Self

Change the starting page of the search.

pub fn param(&mut self, param: Box<dyn Param>) -> &mut Self

Add a param to the search.

Important traits for PaginatedURI<T>

impl<T: DeserializeOwned> Iterator for PaginatedURI<T> type Item = Result<Vec<T>>;

pub fn search(&mut self) -> PaginatedURI<Card>

A covenience method for passing this to a search.

Examples

use scryfall::card::Card;
use scryfall::card_searcher::{
    NumericParam::CollectorNumber, Search, SearchBuilder, StringParam::Set,
};
use scryfall::set::SetCode;
use std::convert::TryFrom;

assert_eq!(
    Card::search(
        SearchBuilder::new()
            .param(Box::new(CollectorNumber(123)))
            .param(Box::new(Set(SetCode::try_from("war").unwrap())))
    )
    .flatten()
    .collect::<Vec<_>>(),
    SearchBuilder::new()
        .param(Box::new(CollectorNumber(123)))
        .param(Box::new(Set(SetCode::try_from("war").unwrap())))
        .search()
        .flatten()
        .collect::<Vec<_>>()
);

Trait Implementations

impl Search for SearchBuilder

fn to_query(&self) -> String

Turns a searchable into it's string representation.

impl Default for SearchBuilder

fn default() -> Self

Returns the "default value" for a type.