Struct SearchOptions

pub struct SearchOptions { /* private fields */ }

Advanced searching options for Scryfall, including unique de-duplication strategy, sort order, page number, and any extras to include. For documentation on each option, refer to this struct’s methods.

For more information, refer to the official docs.

Implementations

impl SearchOptions

pub fn new() -> Self

Constructs a new SearchOptions with default values and an empty query.

pub fn with_query(query: Query) -> Self

Constructs a new SearchOptions with default values and the specified query.

pub fn query(&mut self, query: Query) -> &mut Self

Sets the query to use for this search.

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

Sets the page number to start with. Page 0 is equivalent to page 1.

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

Sets the strategy for omitting similar cards.

pub fn sort(&mut self, order: SortOrder, dir: SortDirection) -> &mut Self

Sets the sort order and direction for returned cards.

pub fn order(&mut self, order: SortOrder) -> &mut Self

Sets the sort order for returned cards.

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

Sets the sort direction for returned cards.

pub fn extras(&mut self, include_extras: bool) -> &mut Self

If true, extra cards (tokens, planes, etc) will be included.

pub fn multilingual(&mut self, include_multilingual: bool) -> &mut Self

If true, cards in every language supported by Scryfall will be included.

pub fn variations(&mut self, include_variations: bool) -> &mut Self

If true, rare care variants will be included, like the Hairy Runesword.

Trait Implementations

impl Debug for SearchOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SearchOptions

fn default() -> SearchOptions

Returns the “default value” for a type.

impl Search for SearchOptions

fn write_query(&self, url: &mut Url) -> Result<()>

Write this search as the query for the given Url.

fn search<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<ListIter<Card>>> + Send + 'async_trait>>

where Self: Sync + 'async_trait, 'life0: 'async_trait,

Convenience method for passing this object to Card::search.

fn search_all<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<Card>>> + Send + 'async_trait>>

where Self: Sync + 'async_trait, 'life0: 'async_trait,

Convenience method for passing this object to Card::search_all.

fn random<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Card>> + Send + 'async_trait>>

where Self: Sync + 'async_trait, 'life0: 'async_trait,

Convenience method for passing this object to Card::search_random.

impl Serialize for SearchOptions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.