scryfall_sdk_rust 0.1.1

A light wrapper (SDK) for Scryfall API (https://scryfall.com/docs/api)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125

//! Scryfall API resources (root module)

use crate::resources::errors::ErrorBody;
use reqwest::Method;
use serde::{Deserialize, Serialize};

pub mod bulk_data;
pub mod card_sets;
pub mod card_symbols;
pub mod cards;
pub mod catalog;
pub mod errors;
pub mod rulings;

/// Represents an HTTP resource (endpoint)
///
/// This is used as a parameter to [Scryfall](super::Scryfall)
/// in order to make a request to the api.
pub trait HttpResource<R: for<'de> Deserialize<'de>> {
    /// Defines the HTTP method for the endpoint
    fn method(&self) -> Method {
        Method::GET
    }

    /// Defines the path for the endpoint
    ///
    /// The path should be relative to the `base_url` of [Scryfall](super::Scryfall)
    fn path(&self) -> String;

    /// Defines the (optional) json body when requesting the endpoint.
    /// 
    /// This is useful in cases of POST/PUT/PATCH etc.
    /// By default it is `None`.
    fn json(&self) -> Option<String> {
        None
    }

    /// Strips the query parameters (if any) from the endpoint path
    /// 
    /// # Example
    /// ```
    /// use scryfall_sdk_rust::HttpResource;
    /// 
    /// struct SomeResource;
    /// impl HttpResource<String> for SomeResource {
    ///     fn path(&self) -> String {
    ///         "somepath?aQueryParam=123".into()
    ///     }
    /// }
    ///
    /// let res = SomeResource;
    /// assert_eq!("somepath", res.path_without_query())
    /// ```
    fn path_without_query(&self) -> String {
        self.path()
            .chars()
            .take(self
                .path()
                .find("?")
                .unwrap_or(self.path().len())
            )
            .collect()
    }
}

/// Represents a Response with two different states:
/// 
/// - Ok -> containing a Model representation for the resource (e.g. Card)
/// - Err -> containing an error response with a specified ErrorBody (e.g. 404 errors)
/// 
/// The distinction is done based on the `object` field in the response
/// which is de-serialized in ResourceKind::Error when it is `error` and to everything
/// else when there is real response with the respective object.__rust_force_expr!
/// 
/// You can see more info on error response model in [Scryfall offical API documenation.](https://scryfall.com/docs/api/errors)
#[derive(Debug, Serialize, Deserialize, PartialEq)]
#[serde(untagged)]
pub enum Response<M>{
    Ok(M),
    Err(ErrorBody),
}

/// Kind of resource
///
/// Scryfall API uses `object` field on each resource to denote its type.
///
/// Essentially this includes all the available core resources from the API
/// plus `list` which refers to a collection of resources.
#[derive(Serialize, Deserialize, Debug, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum ResourceKind {
    /// `object` -> `bulk_data`
    BulkData,

    /// `object` -> `card`
    Card,

    /// `object` -> `card_face`
    CardFace,

    /// `object` -> `card_symbol`
    CardSymbol,

    /// `object` -> `catalog`
    Catalog,

    /// `object` -> `error`
    Error,

    /// `object` -> `list`
    List,

    /// `object` -> `mana_cost`
    ManaCost,

    /// `object` -> `related_card`
    #[serde(rename = "related_card")]
    Related,

    /// `object` -> `ruling`
    Ruling,

    /// `object` -> `set`
    Set,
}