45 releases
0.17.10 | Nov 14, 2024 |
---|---|
0.17.2 | Jul 29, 2024 |
0.16.1 | Feb 1, 2024 |
0.14.2 | Dec 5, 2023 |
0.4.0 | Jul 26, 2019 |
#90 in Game dev
133 downloads per month
Used in daily_scry
235KB
4K
SLoC
scryfall-rs
A wrapper around the scryfall magic the gathering API
It wraps the scryfall API as close to it as possible and I try to keep it up to date
Cards
The main way to fetch cards from this API is the Card
struct.
This allows you to get cards from scryfall
using all of their available
REST Apis
use scryfall::card::Card;
match Card::named_fuzzy("Light Bolt") {
Ok(card) => assert_eq!(card.name, "Lightning Bolt"),
Err(e) => panic!(format!("{:?}", e))
}
Sets
You can also fetch information about a card set.
The available routes for this can be seen on Set
use scryfall::set::Set;
assert_eq!(Set::code("mmq").unwrap().name, "Mercadian Masques")
Dealing with breaking changes
Scryfall makes a lot of breaking api changes, mostly because magic makes a lot
of breaking changes 😅. Due to the strong typing of this crate, this means that
sometimes code that works one day breaks the next day. For example, there's a
PromoType
enum. This enum, when deserializing, will strictly
reject any format it doesn't know about. This means that everytime wizards adds
a new format, scryfall will start returning this new format from its API
which will make your code fail at runtime.
To cope with this I've added a feature called unknown_variants
. This feature
adds to these troublesome enums a variant called Unknown
, which contains the
string representation of the unknown format.
This has a few pros and cons:
- Pros:
- Your code is much less likely to stop working from one day to the next.
- You can exhaustively match on the enum
- Cons:
- The size of the enum is now 24 bytes, instead of 1
- It is no longer Copy
- If you ever depend on a variant being passed through the unknown variant,
when the new variant is added to the enum, it will stop showing up in the
unknown variant. For example, if tomorrow wizards adds a promo type called
"Transparent" and you have
unknown_variants
enabled,"transparent"
will start showing up inside thePromoType::Unknown
variant. But in the next version of this crate, I will addPromoType::Transparent
, which means that if you upgrade your dependency on this crate,"transparent"
will no longer show up inside thePromoType::Unknown
variant. If you depend on that behaviour it will be considered a breaking change.
If you want to have the unknown variant but don't want to pay for the 24 byte
cost, you can opt for the unknown_variants_slim
feature, which will simply add
an empty Unknown
variant instead.
These two features are incompatible and unknown_variants
will take
precedence if both are present.
Dependencies
~6–18MB
~241K SLoC