mtgapi-client 0.2.0

API bindings for www.magicthegathering.io
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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
use crate::api::card::filtertypes::*;
use itertools::Itertools;
use std::fmt::Display;

const SEP_AND: &str = ",";
const SEP_OR: &str = "|";

/// Builder for filtered card requests
#[derive(Clone, Debug)]
pub struct CardFilterBuilder {
    filter: String,
}

impl CardFilterBuilder {
    fn new() -> CardFilterBuilder {
        CardFilterBuilder {
            filter: String::new(),
        }
    }

    /// Creates a CardFilter with the specified filter parameters
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder
    ///     .color(CardColor::Red)
    ///     .converted_mana_cost(2)
    ///     .cardtype(CardType::Instant)
    ///     .build();
    /// assert!(filter == CardFilter("colors=Red&cmc=2&types=Instant".to_string()))
    /// ```
    #[allow(dead_code)]
    pub fn build(self) -> CardFilter {
        CardFilter(self.filter)
    }

    /// Create a custom filter
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.custom("name", "Shock|Mountain")
    ///     .build();
    /// assert!(filter == CardFilter("name=Shock|Mountain".to_string()))
    /// ```
    #[allow(dead_code)]
    pub fn custom<'a, T>(mut self, key: T, value: T) -> CardFilterBuilder
    where
        T: Into<&'a str>,
    {
        self.add_filter(key.into(), value.into());
        self
    }

    /// Every card that (partially) matches the specified name will match the filter
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.name("Shock")
    ///     .build();
    /// assert!(filter == CardFilter("name=Shock".to_string()))
    /// ```
    #[allow(dead_code)]
    pub fn name<'a, T>(mut self, name: T) -> CardFilterBuilder
    where
        T: Into<&'a str>,
    {
        self.add_filter("name", name.into());
        self
    }

    /// Every card that (partially) matches one of the specified names will match the filter
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.names(&vec!["Shock", "Mountain"])
    ///     .build();
    /// assert!(filter == CardFilter("name=Shock|Mountain".to_string()));
    /// ```
    #[allow(dead_code)]
    pub fn names<T>(mut self, names: &[T]) -> CardFilterBuilder
    where
        T: Display,
    {
        let values = names.iter().join(SEP_OR);
        self.add_filter("name", &values);
        self
    }

    /// Every card that (partially) matches the specified name will match the filter
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.name_with_language("Schock", CardLanguage::German)
    ///     .build();
    /// assert!(filter == CardFilter("name=Schock&language=German".to_string()))
    /// ```
    #[allow(dead_code)]
    pub fn name_with_language<'a, T>(mut self, name: T, language: CardLanguage) -> CardFilterBuilder
    where
        T: Into<&'a str>,
    {
        self.add_filter("name", name.into());
        self.add_filter("language", &language.as_str());
        self
    }

    /// Every card that (partially) matches one of the specified names will match the filter
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.names_with_language(&vec!["Schock", "Gebirge"], CardLanguage::German)
    ///     .build();
    /// assert!(filter == CardFilter("name=Schock|Gebirge&language=German".to_string()));
    /// ```
    #[allow(dead_code)]
    pub fn names_with_language<T>(
        mut self,
        names: &[T],
        language: CardLanguage,
    ) -> CardFilterBuilder
    where
        T: Display,
    {
        let values = names.iter().join(SEP_OR);
        self.add_filter("name", &values);
        self.add_filter("language", &language.as_str());
        self
    }

    /// Every card name that has the specified layout will match the filter
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.layout(CardLayout::DoubleFaced)
    ///     .build();
    /// assert!(filter == CardFilter("layout=Double-Faced".to_string()));
    /// ```
    #[allow(dead_code)]
    pub fn layout(mut self, layout: CardLayout) -> CardFilterBuilder {
        self.add_filter("layout", &layout.as_str());
        self
    }

    /// Every card that has one of the specified layouts will match the filter
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.layouts(&vec![CardLayout::Normal, CardLayout::DoubleFaced])
    ///     .build();
    /// assert!(filter == CardFilter("layout=Normal|Double-Faced".to_string()));
    /// ```
    #[allow(dead_code)]
    pub fn layouts(mut self, layouts: &[CardLayout]) -> CardFilterBuilder {
        let values = layouts.iter().map(|value| value.as_str()).join(SEP_OR);
        self.add_filter("layout", &values);
        self
    }

    /// Every card name that has the specified converted mana cost will match the filter
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.converted_mana_cost(3)
    ///     .build();
    /// assert!(filter == CardFilter("cmc=3".to_string()));
    /// ```
    #[allow(dead_code)]
    pub fn converted_mana_cost(mut self, cmc: u8) -> CardFilterBuilder {
        self.add_filter("cmc", &cmc.to_string());
        self
    }

    /// Every card that includes the specified color will match the filter
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.color(CardColor::Red)
    ///     .build();
    /// assert!(filter == CardFilter("colors=Red".to_string()));
    /// ```
    #[allow(dead_code)]
    pub fn color(mut self, color: CardColor) -> CardFilterBuilder {
        self.add_filter("colors", &color.as_str());
        self
    }

    /// Every card that includes one the specified colors will match the filter
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.colors_or(&vec![CardColor::Red, CardColor::Blue])
    ///     .build();
    /// assert!(filter == CardFilter("colors=Red|Blue".to_string()));
    /// ```
    #[allow(dead_code)]
    pub fn colors_or(mut self, colors: &[CardColor]) -> CardFilterBuilder {
        let values = colors.iter().map(|value| value.as_str()).join(SEP_OR);
        self.add_filter("colors", &values);
        self
    }

    /// Every card that includes all the specified colors will match the filter
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.colors_and(&vec![CardColor::Red, CardColor::Blue])
    ///     .build();
    /// assert!(filter == CardFilter("colors=Red,Blue".to_string()));
    /// ```
    #[allow(dead_code)]
    pub fn colors_and(mut self, colors: &[CardColor]) -> CardFilterBuilder {
        let values = colors.iter().map(|value| value.as_str()).join(SEP_AND);
        self.add_filter("colors", &values);
        self
    }

    /// Every card that includes the specified color code will match the filter
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.color_identity(CardColorIdentity::R)
    ///     .build();
    /// assert!(filter == CardFilter("colorIdentity=R".to_string()));
    /// ```
    #[allow(dead_code)]
    pub fn color_identity(mut self, color_identity: CardColorIdentity) -> CardFilterBuilder {
        self.add_filter("colorIdentity", &color_identity.as_str());
        self
    }

    /// Every card that includes one of the specified color codes will match the filter
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.color_identities_or(&vec![CardColorIdentity::R, CardColorIdentity::U])
    ///     .build();
    /// assert!(filter == CardFilter("colorIdentity=R|U".to_string()));
    /// ```
    #[allow(dead_code)]
    pub fn color_identities_or(
        mut self,
        color_identities: &[CardColorIdentity],
    ) -> CardFilterBuilder {
        let values = color_identities
            .iter()
            .map(|value| value.as_str())
            .join(SEP_OR);
        self.add_filter("colorIdentity", &values);
        self
    }

    /// Every card that includes all of the specified color codes will match the filter
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.color_identities_and(&vec![CardColorIdentity::R, CardColorIdentity::U])
    ///     .build();
    /// assert!(filter == CardFilter("colorIdentity=R,U".to_string()));
    /// ```
    #[allow(dead_code)]
    pub fn color_identities_and(
        mut self,
        color_identities: &[CardColorIdentity],
    ) -> CardFilterBuilder {
        let values = color_identities
            .iter()
            .map(|value| value.as_str())
            .join(SEP_AND);
        self.add_filter("colorIdentity", &values);
        self
    }

    /// Every card that (partially) matches the specified types will match the filter
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.fulltype("Legendary Creature")
    ///     .build();
    /// assert!(filter == CardFilter("types=Legendary Creature".to_string()));
    /// ```
    #[allow(dead_code)]
    pub fn fulltype<'a, T>(mut self, fulltype: T) -> CardFilterBuilder
    where
        T: Into<&'a str>,
    {
        self.add_filter("types", &fulltype.into());
        self
    }

    /// Every card that (partially) matches one of the specified types will match the filter
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.fulltypes_or(&vec!["Legendary Creature", "Human"])
    ///     .build();
    /// assert!(filter == CardFilter("types=Legendary Creature|Human".to_string()));
    /// ```
    #[allow(dead_code)]
    pub fn fulltypes_or<T>(mut self, fulltypes: &[T]) -> CardFilterBuilder
    where
        T: Display,
    {
        let values = fulltypes.iter().join(SEP_OR);
        self.add_filter("types", &values);
        self
    }

    /// Every card that (partially) matches all of the specified types will match the filter
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.fulltypes_and(&vec!["Legendary", "Creature", "Human"])
    ///     .build();
    /// assert!(filter == CardFilter("types=Legendary,Creature,Human".to_string()));
    /// ```
    #[allow(dead_code)]
    pub fn fulltypes_and<T>(mut self, fulltypes: &[T]) -> CardFilterBuilder
    where
        T: Display,
    {
        let values = fulltypes.iter().join(SEP_AND);
        self.add_filter("types", &values);
        self
    }

    /// Every card that is of the specified supertype will match the filter
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.supertype(CardSuperType::Legendary)
    ///     .build();
    /// assert!(filter == CardFilter("supertypes=Legendary".to_string()));
    /// ```
    #[allow(dead_code)]
    pub fn supertype(mut self, supertype: CardSuperType) -> CardFilterBuilder {
        self.add_filter("supertypes", &supertype.as_str());
        self
    }

    /// Every card that is one of the specified supertypes will match the filter
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.supertypes_or(&vec![CardSuperType::Basic, CardSuperType::Legendary])
    ///     .build();
    /// assert!(filter == CardFilter("supertypes=Basic|Legendary".to_string()));
    /// ```
    #[allow(dead_code)]
    pub fn supertypes_or(mut self, supertypes: &[CardSuperType]) -> CardFilterBuilder {
        let values = supertypes
            .iter()
            .map(|value| value.as_str())
            .join(SEP_OR);
        self.add_filter("supertypes", &values);
        self
    }

    /// Every card that is all of the specified supertypes will match the filter
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.supertypes_and(&vec![CardSuperType::Basic, CardSuperType::Legendary])
    ///     .build();
    /// assert!(filter == CardFilter("supertypes=Basic,Legendary".to_string()));
    /// ```
    #[allow(dead_code)]
    pub fn supertypes_and(mut self, supertypes: &[CardSuperType]) -> CardFilterBuilder {
        let values = supertypes
            .iter()
            .map(|value| value.as_str())
            .join(SEP_AND);
        self.add_filter("supertypes", &values);
        self
    }

    /// Every card that is of the specified types will match the filter
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.cardtype(CardType::Creature)
    ///     .build();
    /// assert!(filter == CardFilter("types=Creature".to_string()));
    /// ```
    #[allow(dead_code)]
    pub fn cardtype(mut self, cardtype: CardType) -> CardFilterBuilder {
        self.add_filter("types", &cardtype.as_str());
        self
    }

    /// Every card that is of one of the specified types will match the filter
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.cardtypes_or(&vec![CardType::Creature, CardType::Artifact])
    ///     .build();
    /// assert!(filter == CardFilter("types=Creature|Artifact".to_string()));
    /// ```
    #[allow(dead_code)]
    pub fn cardtypes_or(mut self, cardtypes: &[CardType]) -> CardFilterBuilder {
        let values = cardtypes
            .iter()
            .map(|value| value.as_str())
            .join(SEP_OR);
        self.add_filter("types", &values);
        self
    }

    /// Every card that is of all of the specified types will match the filter
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.cardtypes_and(&vec![CardType::Creature, CardType::Artifact])
    ///     .build();
    /// assert!(filter == CardFilter("types=Creature,Artifact".to_string()));
    /// ```
    #[allow(dead_code)]
    pub fn cardtypes_and(mut self, cardtypes: &[CardType]) -> CardFilterBuilder {
        let values = cardtypes
            .iter()
            .map(|value| value.as_str())
            .join(SEP_AND);
        self.add_filter("types", &values);
        self
    }

    /// Every card that is of the specified subtype will match the filter
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.subtype("Human")
    ///     .build();
    /// assert!(filter == CardFilter("subtypes=Human".to_string()));
    /// ```
    #[allow(dead_code)]
    pub fn subtype<'a, T>(mut self, subtype: T) -> CardFilterBuilder
    where
        T: Into<&'a str>,
    {
        self.add_filter("subtypes", &subtype.into());
        self
    }

    /// Every card that is of one of the specified subtypes will match the filter
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.subtypes_or(&vec!["Human", "Soldier"])
    ///     .build();
    /// assert!(filter == CardFilter("subtypes=Human|Soldier".to_string()));
    /// ```
    #[allow(dead_code)]
    pub fn subtypes_or<T>(mut self, subtypes: &[T]) -> CardFilterBuilder
    where
        T: Display,
    {
        let values = subtypes.iter().join(SEP_OR);
        self.add_filter("subtypes", &values);
        self
    }

    /// Every card that is of all of the specified subtypes will match the filter
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.subtypes_and(&vec!["Human", "Soldier"])
    ///     .build();
    /// assert!(filter == CardFilter("subtypes=Human,Soldier".to_string()));
    /// ```
    #[allow(dead_code)]
    pub fn subtypes_and<T>(mut self, subtypes: &[T]) -> CardFilterBuilder
    where
        T: Display,
    {
        let values = subtypes.iter().join(SEP_AND);
        self.add_filter("subtypes", &values);
        self
    }

    /// Every card that is of the specified rarity will match the filter
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.rarity(CardRarity::Rare)
    ///     .build();
    /// assert!(filter == CardFilter("rarity=Rare".to_string()));
    /// ```
    #[allow(dead_code)]
    pub fn rarity(mut self, rarity: CardRarity) -> CardFilterBuilder {
        self.add_filter("rarity", &rarity.as_str());
        self
    }

    /// Every card that is of one of the specified rarities will match the filter
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.rarities(&vec![CardRarity::Rare, CardRarity::MythicRare])
    ///     .build();
    /// assert!(filter == CardFilter("rarity=Rare|Mythic Rare".to_string()));
    /// ```
    #[allow(dead_code)]
    pub fn rarities(mut self, rarities: &[CardRarity]) -> CardFilterBuilder {
        let values = rarities
            .iter()
            .map(|value| value.as_str())
            .join(SEP_OR);
        self.add_filter("rarity", &values);
        self
    }

    /// Every card that is in the specified set will match the filter
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.set("AER")
    ///     .build();
    /// assert!(filter == CardFilter("set=AER".to_string()));
    /// ```
    #[allow(dead_code)]
    pub fn set<'a, T>(mut self, set: T) -> CardFilterBuilder
    where
        T: Into<&'a str>,
    {
        self.add_filter("set", &set.into());
        self
    }

    /// Every card that is in one of the specified sets will match the filter
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.sets(&vec!["AER", "M19"])
    ///     .build();
    /// assert!(filter == CardFilter("set=AER|M19".to_string()));
    /// ```
    #[allow(dead_code)]
    pub fn sets<T>(mut self, sets: &[T]) -> CardFilterBuilder
    where
        T: Display,
    {
        let values = sets.iter().join(SEP_OR);
        self.add_filter("set", &values);
        self
    }

    /// Every card that (partially) matches the specified set name will match the filter
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.set_name("Core Set 2019")
    ///     .build();
    /// assert!(filter == CardFilter("setName=Core Set 2019".to_string()));
    /// ```
    #[allow(dead_code)]
    pub fn set_name<'a, T>(mut self, set: T) -> CardFilterBuilder
    where
        T: Into<&'a str>,
    {
        self.add_filter("setName", &set.into());
        self
    }

    /// Every card that (partially) matches one of the specified set names will match the filter
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.set_names(&vec!["Core Set 2019", "Aether Revolt"])
    ///     .build();
    /// assert!(filter == CardFilter("setName=Core Set 2019|Aether Revolt".to_string()));
    /// ```
    #[allow(dead_code)]
    pub fn set_names<T>(mut self, sets: &[T]) -> CardFilterBuilder
    where
        T: Display,
    {
        let values = sets.iter().join(SEP_OR);
        self.add_filter("setName", &values);
        self
    }

    /// Every card that (partially) matches the specified oracle text will match the filter
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.text("deals 2 damage")
    ///     .build();
    /// assert!(filter == CardFilter("text=deals 2 damage".to_string()));
    /// ```
    #[allow(dead_code)]
    pub fn text<'a, T>(mut self, text: T) -> CardFilterBuilder
    where
        T: Into<&'a str>,
    {
        self.add_filter("text", &text.into());
        self
    }

    /// Every card that (partially) matches one of the specified oracle texts will match the filter
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.texts_or(&vec!["deals", "damage"])
    ///     .build();
    /// assert!(filter == CardFilter("text=deals|damage".to_string()));
    /// ```
    #[allow(dead_code)]
    pub fn texts_or<T>(mut self, texts: &[T]) -> CardFilterBuilder
    where
        T: Display,
    {
        let values = texts.iter().join(SEP_OR);
        self.add_filter("text", &values);
        self
    }

    /// Every card that (partially) matches all of the specified oracle texts will match the filter
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.texts_and(&vec!["deals", "damage"])
    ///     .build();
    /// assert!(filter == CardFilter("text=deals,damage".to_string()));
    /// ```
    #[allow(dead_code)]
    pub fn texts_and<T>(mut self, texts: &[T]) -> CardFilterBuilder
    where
        T: Display,
    {
        let values = texts.iter().join(SEP_AND);
        self.add_filter("text", &values);
        self
    }

    /// Every card that (partially) matches the specified flavour text will match the filter
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.flavor("S.N.E.A.K.")
    ///     .build();
    /// assert!(filter == CardFilter("flavor=S.N.E.A.K.".to_string()));
    /// ```
    #[allow(dead_code)]
    pub fn flavor<'a, T>(mut self, flavor: T) -> CardFilterBuilder
    where
        T: Into<&'a str>,
    {
        self.add_filter("flavor", &flavor.into());
        self
    }

    /// Every card that (partially) matches one of the specified flavour texts will match the filter
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.flavors_or(&vec!["Espionage", "Kidnapping"])
    ///     .build();
    /// assert!(filter == CardFilter("flavor=Espionage|Kidnapping".to_string()));
    /// ```
    #[allow(dead_code)]
    pub fn flavors_or<T>(mut self, flavors: &[T]) -> CardFilterBuilder
    where
        T: Display,
    {
        let values = flavors.iter().join(SEP_OR);
        self.add_filter("flavor", &values);
        self
    }

    /// Every card that (partially) matches all of the specified flavour texts will match the filter
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.flavors_and(&vec!["Serious", "Nonstop Espionage and Kidnapping"])
    ///     .build();
    /// assert!(filter == CardFilter("flavor=Serious,Nonstop Espionage and Kidnapping".to_string()));
    /// ```
    #[allow(dead_code)]
    pub fn flavors_and<T>(mut self, flavors: &[T]) -> CardFilterBuilder
    where
        T: Display,
    {
        let values = flavors.iter().join(SEP_AND);
        self.add_filter("flavor", &values);
        self
    }

    /// Every card that is drawn by the specified artist will match the filter
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.artist("Kev Walker")
    ///     .build();
    /// assert!(filter == CardFilter("artist=Kev Walker".to_string()));
    /// ```
    #[allow(dead_code)]
    pub fn artist<'a, T>(mut self, artist: T) -> CardFilterBuilder
    where
        T: Into<&'a str>,
    {
        self.add_filter("artist", &artist.into());
        self
    }

    /// Every card that is drawn by one of the specified artists will match the filter
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.artists(&vec!["Kev Walker", "Pete Venters"])
    ///     .build();
    /// assert!(filter == CardFilter("artist=Kev Walker|Pete Venters".to_string()));
    /// ```
    #[allow(dead_code)]
    pub fn artists<T>(mut self, artists: &[T]) -> CardFilterBuilder
    where
        T: Display,
    {
        let values = artists.iter().join(SEP_OR);
        self.add_filter("artist", &values);
        self
    }

    /// Every card with the specified card number will match the filter
    ///
    /// The card number may contain letters
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.number("1")
    ///     .build();
    /// assert!(filter == CardFilter("number=1".to_string()));
    /// ```
    #[allow(dead_code)]
    pub fn number<'a, T>(mut self, number: T) -> CardFilterBuilder
    where
        T: Into<&'a str>,
    {
        self.add_filter("number", &number.into());
        self
    }

    /// Every card with one of the specified card numbers will match the filter
    ///
    /// The card number may contain letters
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.numbers(&vec!["1", "2"])
    ///     .build();
    /// assert!(filter == CardFilter("number=1|2".to_string()));
    /// ```
    #[allow(dead_code)]
    pub fn numbers<T>(mut self, numbers: &[T]) -> CardFilterBuilder
    where
        T: Display,
    {
        let values = numbers.iter().join(SEP_OR);
        self.add_filter("number", &values);
        self
    }

    /// Every card with the specified power will match the filter
    ///
    /// Some cards have powers like: “1+*”
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.power("1")
    ///     .build();
    /// assert!(filter == CardFilter("power=1".to_string()));
    /// ```
    #[allow(dead_code)]
    pub fn power<'a, T>(mut self, power: T) -> CardFilterBuilder
    where
        T: Into<&'a str>,
    {
        self.add_filter("power", &power.into());
        self
    }

    /// Every card with one of the specified powers will match the filter
    ///
    /// Some cards have powers like: “1+*”
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.powers(&vec!["1", "2"])
    ///     .build();
    /// assert!(filter == CardFilter("power=1|2".to_string()));
    /// ```
    #[allow(dead_code)]
    pub fn powers<T>(mut self, powers: &[T]) -> CardFilterBuilder
    where
        T: Display,
    {
        let values = powers.iter().join(SEP_OR);
        self.add_filter("power", &values);
        self
    }

    /// Every card with the specified toughness will match the filter
    ///
    /// Some cards have toughness like: “1+*”
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.toughness("1")
    ///     .build();
    /// assert!(filter == CardFilter("toughness=1".to_string()));
    /// ```
    #[allow(dead_code)]
    pub fn toughness<'a, T>(mut self, toughness: T) -> CardFilterBuilder
    where
        T: Into<&'a str>,
    {
        self.add_filter("toughness", &toughness.into());
        self
    }

    /// Every card with one of the specified toughnesses will match the filter
    ///
    /// Some cards have toughnesses like: “1+*”
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.toughnesses(&vec!["1", "2"])
    ///     .build();
    /// assert!(filter == CardFilter("toughness=1|2".to_string()));
    /// ```
    #[allow(dead_code)]
    pub fn toughnesses<T>(mut self, toughnesses: &[T]) -> CardFilterBuilder
    where
        T: Display,
    {
        let values = toughnesses.iter().join(SEP_OR);
        self.add_filter("toughness", &values);
        self
    }

    /// Every card with the specified loyality will match the filter
    ///
    /// This is only present for planeswalkers
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.loyality("3")
    ///     .build();
    /// assert!(filter == CardFilter("loyality=3".to_string()));
    /// ```
    #[allow(dead_code)]
    pub fn loyality<'a, T>(mut self, loyality: T) -> CardFilterBuilder
    where
        T: Into<&'a str>,
    {
        self.add_filter("loyality", &loyality.into());
        self
    }

    /// Every card with one of the specified loyalities will match the filter
    ///
    /// This is only present for planeswalkers
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.loyalities(&vec!["3", "5"])
    ///     .build();
    /// assert!(filter == CardFilter("loyality=3|5".to_string()));
    /// ```
    #[allow(dead_code)]
    pub fn loyalities<T>(mut self, loyalities: &[T]) -> CardFilterBuilder
    where
        T: Display,
    {
        let values = loyalities.iter().join(SEP_OR);
        self.add_filter("loyality", &values);
        self
    }

    /// Every card that is legal in the specified game format will match the filter
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.game_format(GameFormat::Standard)
    ///     .build();
    /// assert!(filter == CardFilter("gameFormat=Standard".to_string()));
    /// ```
    #[allow(dead_code)]
    pub fn game_format(mut self, format: GameFormat) -> CardFilterBuilder {
        self.add_filter("gameFormat", &format.as_str());
        self
    }

    /// Every card that is legal in the specified game formats will match the filter
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.game_format(GameFormat::Standard)
    ///     .build();
    /// assert!(filter == CardFilter("gameFormat=Standard".to_string()));
    /// ```
    #[allow(dead_code)]
    pub fn game_formats(mut self, formats: &[GameFormat]) -> CardFilterBuilder {
        let values = formats.iter().map(|value| value.as_str()).join(SEP_OR);
        self.add_filter("gameFormat", &values);
        self
    }

    /// Every card that is of the specified legality in the specified game format will match the filter
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.game_format_with_legality(GameFormat::Commander, CardLegality::Banned)
    ///     .build();
    /// assert!(filter == CardFilter("gameFormat=Commander&legality=Banned".to_string()));
    /// ```
    #[allow(dead_code)]
    pub fn game_format_with_legality(
        mut self,
        format: GameFormat,
        legality: CardLegality,
    ) -> CardFilterBuilder {
        self.add_filter("gameFormat", &format.as_str());
        self.add_filter("legality", &legality.as_str());
        self
    }

    /// Every card that is of the specified legality in the specified game formats will match the filter
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.game_formats_with_legality(&vec![GameFormat::Standard, GameFormat::Commander], CardLegality::Banned)
    ///     .build();
    /// assert!(filter == CardFilter("gameFormat=Standard|Commander&legality=Banned".to_string()));
    /// ```
    #[allow(dead_code)]
    pub fn game_formats_with_legality(
        mut self,
        formats: &[GameFormat],
        legality: CardLegality,
    ) -> CardFilterBuilder {
        let values = formats.iter().map(|value| value.as_str()).join(SEP_OR);
        self.add_filter("gameFormat", &values);
        self.add_filter("legality", &legality.as_str());
        self
    }

    fn add_filter<T>(&mut self, key: T, values: T)
    where
        T: Display,
    {
        if !self.filter.is_empty() {
            self.filter = [&self.filter, "&"].join("");
        }
        self.filter = self.filter.clone() + &[key, values].iter().join("=")
    }

    /// Every card with the specified multiverse Id will match the filter
    ///
    /// This is only present for planeswalkers
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.multiverse_id("409741")
    ///     .build();
    /// assert!(filter == CardFilter("multiverseid=409741".to_string()));
    /// ```
    #[allow(dead_code)]
    pub fn multiverse_id<'a, T>(mut self, multiverse_id: T) -> CardFilterBuilder
    where
        T: Into<&'a str>,
    {
        self.add_filter("multiverseid", &multiverse_id.into());
        self
    }

    /// Every card with one of the specified multiverse Ids will match the filter
    ///
    /// This is only present for planeswalkers
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.multiverse_ids(&vec!["409741", "409742"])
    ///     .build();
    /// assert!(filter == CardFilter("multiverseid=409741|409742".to_string()));
    /// ```
    #[allow(dead_code)]
    pub fn multiverse_ids<T>(mut self, multiverse_ids: &[T]) -> CardFilterBuilder
    where
        T: Display,
    {
        let values = multiverse_ids.iter().join(SEP_OR);
        self.add_filter("multiverseid", &values);
        self
    }

    /// Every card that contains the specified field in the response will match the filter
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.contains_field(CardResponseField::ImageUrl)
    ///     .build();
    /// assert!(filter == CardFilter("contains=imageUrl".to_string()));
    /// ```
    #[allow(dead_code)]
    pub fn contains_field(mut self, field: CardResponseField) -> CardFilterBuilder {
        self.add_filter("contains", &field.as_str());
        self
    }

    /// Every card that contains one of the specified fields in the response will match the filter
    ///
    /// ```
    /// # use mtgapi_client::prelude::*;
    /// let builder = CardFilter::builder();
    /// let filter = builder.contains_fields(&vec![CardResponseField::ImageUrl, CardResponseField::MultiverseId])
    ///     .build();
    /// assert!(filter == CardFilter("contains=imageUrl|multiverseid".to_string()));
    /// ```
    #[allow(dead_code)]
    pub fn contains_fields(mut self, fields: &[CardResponseField]) -> CardFilterBuilder {
        let values = fields.iter().map(|value| value.as_str()).join(SEP_OR);
        self.add_filter("contains", &values);
        self
    }
}

/// Wrapper around the filter string to be used for filtered card api requests
#[derive(PartialEq, Eq, Clone, Debug)]
pub struct CardFilter(pub String);

impl CardFilter {
    /// Creates a new CardFilterBuilder
    #[allow(dead_code)]
    pub fn builder() -> CardFilterBuilder {
        CardFilterBuilder::new()
    }
}