Enum scryfall::search::query::Query

pub enum Query {
    And(Vec<Query>),
    Or(Vec<Query>),
    Not(Box<Query>),
    Param(Param),
    Custom(String),
}

A search query, composed of search parameters and boolean operations.

Query is an expression tree, supporting AND, OR, and NOT operations, with the And, Or, and Not variants respectively. Leaf variants are Param and Custom.

Examples

use scryfall::card::Rarity;
let one_odd_eldrazi = Query::And(vec![
    Query::Or(vec![power(9), toughness(9)]),
    Query::Custom("t:eldrazi".to_string()),
    set("bfz"),             // A `Param` variant.
    rarity(Rarity::Mythic), // A `Param` variant.
    CardIs::OddCmc.into(),
])
.search()
.await?
.next()
.await
.unwrap()?;
assert_eq!(one_odd_eldrazi.name, "Void Winnower");

For information on search parameters, see the param module.

Variants

And(Vec<Query>)

The returned cards must match all of the sub-queries.

Or(Vec<Query>)

The returned cards must match at least one of the sub-queries.

Not(Box<Query>)

The returned cards must not match the sub-query.

Param(Param)

The returned cards must match the specified search Param.

Custom(String)

A custom query, in valid Scryfall syntax.

Note: This variant is provided so that users of this crate can use the latest search features on scryfall.com without waiting for the crate to be updated. If you encounter a situation where this must be used, please file an issue.

Implementations

impl Query

pub fn and(self, other: impl Into<Query>) -> Self

Combines self with other using the boolean AND operation.

pub fn or(self, other: impl Into<Query>) -> Self

Combines self with other using the boolean OR operation.

Trait Implementations

impl Clone for Query

fn clone(&self) -> Query

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Query

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

Formats the value using the given formatter.

impl Default for Query

fn default() -> Self

Returns the “default value” for a type.

impl Display for Query

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

Formats the value using the given formatter.

impl From<CardIs> for Query

fn from(card: CardIs) -> Self

Converts to this type from the input type.

impl From<Criterion> for Query

fn from(criterion: Criterion) -> Self

Converts to this type from the input type.

impl From<Param> for Query

fn from(param: Param) -> Self

Converts to this type from the input type.

impl From<PrintingIs> for Query

fn from(printing: PrintingIs) -> Self

Converts to this type from the input type.

impl PartialEq for Query

fn eq(&self, other: &Query) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Search for Query

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 StructuralPartialEq for Query