Struct scryfall::uri::Uri

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

An unresolved URI returned by the Scryfall API, or generated by this crate.

The fetch method handles requesting the resource from the API endpoint, and deserializing it into a T object. If the type parameter is List<_>, then additional methods fetch_iter and fetch_all are available, giving access to objects from all pages of the collection.

Implementations

impl<T: DeserializeOwned> Uri<T>

pub async fn fetch(&self) -> Result<T>

Fetches a resource from the Scryfall API and deserializes it into a type T.

Example

let uri =
    Uri::<Card>::try_from("https://api.scryfall.com/cards/named?exact=Lightning+Bolt").unwrap();
let bolt = uri.fetch().await.unwrap();
assert_eq!(bolt.mana_cost, Some("{R}".to_string()));

impl<T: DeserializeOwned + Send + Sync + Unpin> Uri<List<T>>

pub async fn fetch_iter(&self) -> Result<ListIter<T>>

Lazily iterate over items from all pages of a list. Following pages are requested once the previous page has been exhausted.

Example

use futures::stream::StreamExt;
use futures::future;
let uri = Uri::<List<Card>>::try_from("https://api.scryfall.com/cards/search?q=zurgo").unwrap();
assert!(
    uri.fetch_iter()
        .await
        .unwrap()
        .into_stream()
        .map(Result::unwrap)
        .filter(|c| future::ready(c.name.contains("Bellstriker")))
        .collect::<Vec<_>>()
        .await
        .len()
         > 0
);

use futures::stream::StreamExt;
use futures::future;
let uri = Uri::<List<Card>>::try_from("https://api.scryfall.com/cards/search?q=zurgo").unwrap();
assert!(
    uri.fetch_iter()
        .await
        .unwrap()
        .into_stream_buffered(10)
        .map(Result::unwrap)
        .filter(|c| future::ready(c.name.contains("Bellstriker")))
        .collect::<Vec<_>>()
        .await
        .len()
         > 0
);

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

Eagerly fetch items from all pages of a list. If any of the pages fail to load, returns an error.

Example

let uri =
    Uri::<List<Card>>::try_from("https://api.scryfall.com/cards/search?q=e:ddu&unique=prints")
        .unwrap();
assert_eq!(uri.fetch_all().await.unwrap().len(), 76);

Trait Implementations

impl<T: Clone> Clone for Uri<T>

fn clone(&self) -> Uri<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Uri<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for Uri<T>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> From<Url> for Uri<T>

fn from(url: Url) -> Self

Converts to this type from the input type.

impl<T: Hash> Hash for Uri<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: PartialEq> PartialEq for Uri<T>

fn eq(&self, other: &Uri<T>) -> 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<T> Serialize for Uri<T>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> TryFrom<&str> for Uri<T>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(url: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl<T: Eq> Eq for Uri<T>

impl<T> StructuralPartialEq for Uri<T>