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
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
//! A strongly-typed (a)synchronous Rusty API for the Google Geocoding API
//!
//! ## Synchronous API (Basic)
//!
//! The synchronous API is optimized for the ergonomics of common usage.
//!
//! You can do a simple look up of coordinates from an address:
//!
//! ```
//! use google_geocoding::geocode;
//! for coordinates in geocode("1600 Amphitheater Parkway, Mountain View, CA").unwrap() {
//!     println!("{}", coordinates);
//! }
//! ```
//!
//! Do a simple look up of an address from coordinates:
//!
//! ```
//! use google_geocoding::{WGS84, degeocode};
//! let coordinates = WGS84::try_new(37.42241, -122.08561, 0.0).unwrap();
//! for address in degeocode(coordinates).unwrap() {
//!     println!("{}", address);
//! }
//! ```
//!
//! Note that it is recommended to use WGS84::try_new() as WGS84::new() will panic
//! with invalid coordinates
//!
//! The synchronous API provides the address or coordinates from the API reply.
//! However, the full reply includes a great deal more information. For access to
//! the full reply, see the lowlevel asynchronous API.
//!
//! ## Synchronous API (Advanced)
//!
//! The GeocodeQuery and DegeocodeQuery objects can be used for more complex lookups
//!
//! ```
//! use google_geocoding::{GeocodeQuery, Language, Region, geocode};
//! let query = GeocodeQuery::new("1600 Amphitheater Parkway, Mountain View, CA")
//!     .language(Language::English)
//!     .region(Region::UnitedStates);
//! for coordinates in geocode(query).unwrap() {
//!     println!("{}", coordinates);
//! }
//! ```
//!
//! ## Asynchronous API
//!
//! The Connection object provides access to the lowlevel async-based API.
//!
//! Unlike the synchronous API, these functions provide the full API reply.
//! You will therefore need to extract the specific information you want.
//!
//! These functions are used to implement the Synchronous API described earlier.
//!
//! ```
//! extern crate google_geocoding;
//! extern crate tokio_core;
//!
//! use google_geocoding::Connection;
//! use tokio_core::reactor::Core;
//!
//! const ADDRESS: &str = "1600 Amphitheater Parkway, Mountain View, CA";
//!
//! let mut core = Core::new().unwrap();
//! let core_handle = core.handle();
//! let geocode_future = Connection::new(&core_handle).geocode(ADDRESS);
//! let reply = core.run(geocode_future).unwrap();
//!
//! for candidate in reply {
//!     println!("{}: {}", candidate.formatted_address, candidate.geometry.location);
//! }
//! ```
//!
//! ## Notes
//!
//! This is an unofficial library.
//!
//! [Official Google Geocoding API](https://developers.google.com/maps/documentation/geocoding/intro])
#![deny(missing_docs)]
#[macro_use]
extern crate failure;
extern crate futures;
extern crate itertools;
#[cfg(test)]
#[macro_use]
extern crate log;
extern crate nav_types;
extern crate reqwest;
extern crate serde;
#[macro_use]
extern crate serde_derive;
extern crate serde_json;
extern crate serde_urlencoded;
#[macro_use]
extern crate shrinkwraprs;
extern crate strum;
#[macro_use]
extern crate strum_macros;
extern crate tokio_core;
extern crate url;
mod serde_util;

use futures::{Future, Stream};

use failure::Error;
pub use nav_types::WGS84;
use reqwest::unstable::async::Client;
use serde::{Deserialize, Deserializer, Serialize, Serializer};
use std::cmp::Eq;
use std::collections::HashSet;
use std::fmt::{self, Debug, Display, Formatter};
use std::hash::Hash;
use tokio_core::reactor::Core;
use url::Url;

type Result<T> = std::result::Result<T, Error>;

/// One component of a separated address
#[derive(Debug, Deserialize, Serialize)]
pub struct AddressComponent {
    /// The full text description or name of the address component as returned by the Geocoder.
    long_name: String,
    /// An abbreviated textual name for the address component, if available.
    /// For example, an address component for the state of Alaska may have a long_name of "Alaska" and a short_name of "AK" using the 2-letter postal abbreviation.
    short_name: String,
    /// The type of the address component.
    types: Vec<Type>,
}

/// Position information
#[derive(Debug, Deserialize)]
pub struct Geometry {
    /// The geocoded latitude, longitude value.
    /// For normal address lookups, this field is typically the most important.
    pub location: Coordinates,
    /// Stores additional data about the specified location
    pub location_type: LocationType,
    /// the recommended viewport for displaying the returned result, specified as two latitude,longitude values defining the southwest and northeast corner of the viewport bounding box. Generally the viewport is used to frame a result when displaying it to a user.
    pub viewport: Viewport,
    /// The bounding box which can fully contain the returned result.
    /// Note that these bounds may not match the recommended viewport. (For example, San Francisco includes the Farallon islands, which are technically part of the city, but probably should not be returned in the viewport.)
    pub bounds: Option<Viewport>
}

/// What location Geometry refers to
#[derive(Clone, Copy, Debug, Deserialize, Eq, Hash, PartialEq, Serialize)]
#[serde(rename_all="SCREAMING_SNAKE_CASE")]
pub enum LocationType {
    /// Indicates that the returned result is a precise geocode
    /// for which we have location information accurate down to street address precision.
    Rooftop,

    /// Indicates that the returned result reflects an approximation (usually on a road)
    /// interpolated between two precise points (such as intersections).
    /// Interpolated results are generally returned when rooftop geocodes
    /// are unavailable for a street address.
    RangeInterpolated,

    /// Indicates that the returned result is the geometric center of a result
    /// such as a polyline (for example, a street) or polygon (region).
    GeometricCenter,

    /// Indicates that the returned result is approximate.
    Approximate,
}

/// An API set that deseriaizes as a JSON array and serializes with pipe spaces
#[derive(Clone, Debug, Shrinkwrap)]
pub struct ApiSet<T>(HashSet<T>) where T: Eq + Hash + Serialize;

impl<'de,T> Deserialize<'de> for ApiSet<T>
    where T: Eq + Hash + Deserialize<'de> + Serialize {
    fn deserialize<D>(deserializer: D) -> std::result::Result<Self, D::Error> where D: Deserializer<'de> {
        Ok(ApiSet(Vec::<T>::deserialize(deserializer)?.into_iter().collect()))
    }
}

impl<T> Serialize for ApiSet<T>
    where T: Eq + Hash + Serialize {
    fn serialize<S>(&self, serializer: S) -> std::result::Result<S::Ok, S::Error> where S: Serializer {
        use itertools::Itertools;
        serializer.serialize_str(&self.0.iter().map(serde_util::variant_name).join("|"))
    }
}

/// A human-readable address of this location.
#[derive(Debug,Deserialize)]
pub struct FormattedAddress(String);

impl Display for FormattedAddress {
    fn fmt(&self, f: &mut Formatter) -> fmt::Result {
        Display::fmt(&self.0, f)
    }
}

/// A reply from the Google geocoding API
#[derive(Debug, Deserialize)]
pub struct Reply {
    /// The separate components applicable to this address. 
    pub address_components: Vec<AddressComponent>,
    /// The human-readable address of this location.
    /// 
    /// Often this address is equivalent to the postal address. Note that some countries, such as the United Kingdom, do not allow distribution of true postal addresses due to licensing restrictions.
    ///
    /// The formatted address is logically composed of one or more address components. For example, the address "111 8th Avenue, New York, NY" consists of the following components: "111" (the street number), "8th Avenue" (the route), "New York" (the city) and "NY" (the US state).
    ///
    /// Do not parse the formatted address programmatically. Instead you should use the individual address components, which the API response includes in addition to the formatted address field.
    pub formatted_address: FormattedAddress,
    /// Position information
    pub geometry: Geometry,
    /// A unique identifier that can be used with other Google APIs.
    pub place_id: PlaceId,
    /// All the localities contained in a postal code.
    /// This is only present when the result is a postal code that contains multiple localities.
    pub postcode_localities: Option<Vec<String>>,

    /// The type of the returned result. This array contains a set of zero or more tags identifying the type of feature returned in the result. For example, a geocode of "Chicago" returns "locality" which indicates that "Chicago" is a city, and also returns "political" which indicates it is a political entity.
    pub types: Vec<Type>,
}

#[derive(Debug, Deserialize)]
struct ReplyResult {
    error_message: Option<String>,
    results: Vec<Reply>,
    status: StatusCode,
}

/// Status codes for the geocode API
#[derive(Debug, Deserialize, Fail)]
#[serde(rename_all="SCREAMING_SNAKE_CASE")]
pub enum StatusCode {
    /// Indicates that no errors occurred;
    /// the address was successfully parsed and at least one geocode was returned.
    #[fail(display="No errors occurred")]
    Ok,

    /// Indicates that the geocode was successful but returned no results.
    /// This may occur if the geocoder was passed a non-existent address.
    #[fail(display="Geocode was successful but returned no results.")]
    ZeroResults,

    /// Indicates that you are over your quota.
    #[fail(display="You are over your quota")]
    OverQueryLimit,

    /// Indicates that your request was denied
    #[fail(display="Request denied")]
    RequestDenied,

    /// generally indicates that the query (address, components or latlng) is missing.
    #[fail(display="Query component missing")]
    InvalidRequest,

    /// Indicates that the request could not be processed due to a server error.
    /// The request may succeed if you try again.
    #[fail(display="Unknown error")]
    UnknownError
}

/// The type of an address (eg street, intersection, etc)
#[derive(Clone, Copy, Debug, Deserialize, Eq, Hash, PartialEq, Serialize)]
#[serde(rename_all="snake_case")]
pub enum Type {
    /// Indicates a precise street address.
    StreetAddress,

    /// Indicates a named route (such as "US 101").
    Route,

    /// Indicates a major intersection, usually of two major roads.
    Intersection,

    /// Indicates a political entity.
    /// Usually, this type indicates a polygon of some civil administration.
    Political,

    /// Indicates the national political entity,
    /// and is typically the highest order type returned by the Geocoder.
    Country,

    /// Indicates a first-order civil entity below the country level.
    /// Within the United States, these administrative levels are states.
    /// Not all nations exhibit these administrative levels.
    /// In most cases, administrative_area_level_1 short names will closely match
    /// ISO 3166-2 subdivisions and other widely circulated lists;
    /// however this is not guaranteed as our geocoding results are based
    /// on a variety of signals and location data.
    #[serde(rename="administrative_area_level_1")]
    AdministrativeAreaLevel1,

    /// Indicates a second-order civil entity below the country level.
    /// Within the United States, these administrative levels are counties.
    /// Not all nations exhibit these administrative levels.
    #[serde(rename="administrative_area_level_2")]
    AdministrativeAreaLevel2,

    /// Indicates a third-order civil entity below the country level.
    /// This type indicates a minor civil division.
    /// Not all nations exhibit these administrative levels.
    #[serde(rename="administrative_area_level_3")]
    AdministrativeAreaLevel3,

    /// Indicates a fourth-order civil entity below the country level.
    /// This type indicates a minor civil division.
    /// Not all nations exhibit these administrative levels.
    #[serde(rename="administrative_area_level_4")]
    AdministrativeAreaLevel4,

    /// Indicates a fifth-order civil entity below the country level.
    /// This type indicates a minor civil division.
    /// Not all nations exhibit these administrative levels.
    #[serde(rename="administrative_area_level_5")]
    AdministrativeAreaLevel5,

    /// Indicates a commonly-used alternative name for the entity.
    ColloquialArea,

    /// Indicates an incorporated city or town political entity.
    Locality,

    /// Indicates a specific type of Japanese locality,
    /// to facilitate distinction between multiple locality components within a Japanese address.
    Ward,

    /// Indicates a first-order civil entity below a locality.
    /// For some locations may receive one of the additional types:
    /// sublocality_level_1 to sublocality_level_5.
    /// Each sublocality level is a civil entity.
    /// Larger numbers indicate a smaller geographic area.
    Sublocality,

    /// Indicates a named neighborhood
    Neighborhood,

    /// Indicates a named location, usually a building or collection of buildings with a common name
    Premise,

    /// Indicates a first-order entity below a named location,
    /// usually a singular building within a collection of buildings with a common name
    Subpremise,

    /// Indicates a postal code as used to address postal mail within the country.
    PostalCode,

    /// Indicates a prominent natural feature.
    NaturalFeature,

    /// Indicates an airport.
    Airport,

    /// Indicates a named park.
    Park,

    /// Indicates a named point of interest.
    /// Typically, these "POI"s are prominent local entities
    /// that don't easily fit in another category, such as "Empire State Building"
    /// or "Statue of Liberty."
    PointOfInterest,

    /// Indicates the floor of a building address.
    Floor,

    /// Typically indicates a place that has not yet been categorized.
    Establishment,

    /// Indicates a parking lot or parking structure.
    Parking,

    /// Indicates a specific postal box.
    PostBox,

    /// Indicates a grouping of geographic areas, such as locality and sublocality,
    /// used for mailing addresses in some countries.
    PostalTown,

    /// Indicates the room of a building address.
    Room,

    /// Indicates the precise street number.
    StreetNumber,

    /// Indicate the location of a bus stop.
    BusStation,

    /// Indicate the location of a train station.
    TrainStation,

    /// Indicate the location of a public transit station.
    TransitStation,
}

/// 
#[derive(Clone,Copy,Debug,Deserialize,Serialize)]
pub struct Viewport {
    /// Northeast corner of the bounding box
    pub northeast: Coordinates,
    /// Southwest corner of the bounding box
    pub southwest: Coordinates,
}

/// Language that gets serialized as a language code
/// 
/// From https://developers.google.com/maps/faq#languagesupport
#[derive(Clone,Copy,Debug,EnumIter,Serialize)]
#[allow(dead_code)]
pub enum Language {
    /// Arabic (ar)
    #[serde(rename="ar")] Arabic,
    /// Bulgarian (bg)
    #[serde(rename="bg")] Bulgarian,
    /// Bengali (bn)
    #[serde(rename="bn")] Bengali,
    /// Catalan (ca)
    #[serde(rename="ca")] Catalan,
    /// Czech (cs)
    #[serde(rename="cs")] Czech,
    /// Danish (da)
    #[serde(rename="da")] Danish,
    /// German (de)
    #[serde(rename="de")] German,
    /// Greek (el)
    #[serde(rename="el")] Greek,
    /// English (en)
    #[serde(rename="en")] English,
    /// EnglishAustralian (en-AU)
    #[serde(rename="en-AU")] EnglishAustralian,
    /// EnglishGreatBritain (en-GB)
    #[serde(rename="en-GB")] EnglishGreatBritain,
    /// Spanish (es)
    #[serde(rename="es")] Spanish,
    /// Basque (eu)
    #[serde(rename="eu")] Basque,
    /// Farsi (fa)
    #[serde(rename="fa")] Farsi,
    /// Finnish (fi)
    #[serde(rename="fi")] Finnish,
    /// Filipino (fil)
    #[serde(rename="fil")] Filipino,
    /// French (fr)
    #[serde(rename="fr")] French,
    /// Galician (gl)
    #[serde(rename="gl")] Galician,
    /// Gujarati (gu)
    #[serde(rename="gu")] Gujarati,
    /// Hindi (hi)
    #[serde(rename="hi")] Hindi,
    /// Croatian (hr)
    #[serde(rename="hr")] Croatian,
    /// Hungarian (hu)
    #[serde(rename="hu")] Hungarian,
    /// Indonesian (id)
    #[serde(rename="id")] Indonesian,
    /// Italian (it)
    #[serde(rename="it")] Italian,
    /// Hebrew (iw)
    #[serde(rename="iw")] Hebrew,
    /// Japanese (ja)
    #[serde(rename="ja")] Japanese,
    /// Kannada (kn)
    #[serde(rename="kn")] Kannada,
    /// Korean (ko)
    #[serde(rename="ko")] Korean,
    /// Lithuanian (lt)
    #[serde(rename="lt")] Lithuanian,
    /// Latvian (lv)
    #[serde(rename="lv")] Latvian,
    /// Malayalam (ml)
    #[serde(rename="ml")] Malayalam,
    /// Marathi (mr)
    #[serde(rename="mr")] Marathi,
    /// Dutch (nl)
    #[serde(rename="nl")] Dutch,
    /// Norwegian (no)
    #[serde(rename="no")] Norwegian,
    /// Polish (pl)
    #[serde(rename="pl")] Polish,
    /// Portuguese (pt)
    #[serde(rename="pt")] Portuguese,
    /// PortugueseBrazil (pt-BR)
    #[serde(rename="pt-BR")] PortugueseBrazil,
    /// PortuguesePortugal (pt-PT)
    #[serde(rename="pt-PT")] PortuguesePortugal,
    /// Romanian (ro)
    #[serde(rename="ro")] Romanian,
    /// Russian (ru)
    #[serde(rename="ru")] Russian,
    /// Slovak (sk)
    #[serde(rename="sk")] Slovak,
    /// Slovenian (sl)
    #[serde(rename="sl")] Slovenian,
    /// Serbian (sr)
    #[serde(rename="sr")] Serbian,
    /// Swedish (sv)
    #[serde(rename="sv")] Swedish,
    /// Tamil (ta)
    #[serde(rename="ta")] Tamil,
    /// Telugu (te)
    #[serde(rename="te")] Telugu,
    /// Thai (th)
    #[serde(rename="th")] Thai,
    /// Tagalog (tl)
    #[serde(rename="tl")] Tagalog,
    /// Turkish (tr)
    #[serde(rename="tr")] Turkish,
    /// Ukrainian (uk)
    #[serde(rename="uk")] Ukrainian,
    /// Vietnamese (vi)
    #[serde(rename="vi")] Vietnamese,
    /// ChineseSimplified (zh-CN)
    #[serde(rename="zh-CN")] ChineseSimplified,
    /// ChineseTraditional (zh-TW)
    #[serde(rename="zh-TW")] ChineseTraditional,
}

/// Country Code Top-Level Domain
/// From https://icannwiki.org/Country_code_top-level_domain
#[derive(Clone,Copy,Debug,EnumIter,Serialize)]
#[allow(dead_code)]
pub enum Region {
    /// AscensionIsland (.ac)
    #[serde(rename=".ac")] AscensionIsland,
    /// Andorra (.ad)
    #[serde(rename=".ad")] Andorra,
    /// UnitedArabEmirates (.ae)
    #[serde(rename=".ae")] UnitedArabEmirates,
    /// Afghanistan (.af)
    #[serde(rename=".af")] Afghanistan,
    /// AntiguaAndBarbuda (.ag)
    #[serde(rename=".ag")] AntiguaAndBarbuda,
    /// Anguilla (.ai)
    #[serde(rename=".ai")] Anguilla,
    /// Albania (.al)
    #[serde(rename=".al")] Albania,
    /// Armenia (.am)
    #[serde(rename=".am")] Armenia,
    /// AntillesNetherlands (.an)
    #[serde(rename=".an")] AntillesNetherlands,
    /// Angola (.ao)
    #[serde(rename=".ao")] Angola,
    /// Antarctica (.aq)
    #[serde(rename=".aq")] Antarctica,
    /// Argentina (.ar)
    #[serde(rename=".ar")] Argentina,
    /// AmericanSamoa (.as)
    #[serde(rename=".as")] AmericanSamoa,
    /// Austria (.at)
    #[serde(rename=".at")] Austria,
    /// Australia (.au)
    #[serde(rename=".au")] Australia,
    /// Aruba (.aw)
    #[serde(rename=".aw")] Aruba,
    /// AlandIslands (.ax)
    #[serde(rename=".ax")] AlandIslands,
    /// Azerbaijan (.az)
    #[serde(rename=".az")] Azerbaijan,
    /// BosniaAndHerzegovina (.ba)
    #[serde(rename=".ba")] BosniaAndHerzegovina,
    /// Barbados (.bb)
    #[serde(rename=".bb")] Barbados,
    /// Bangladesh (.bd)
    #[serde(rename=".bd")] Bangladesh,
    /// Belgium (.be)
    #[serde(rename=".be")] Belgium,
    /// BurkinaFaso (.bf)
    #[serde(rename=".bf")] BurkinaFaso,
    /// Bulgaria (.bg)
    #[serde(rename=".bg")] Bulgaria,
    /// Bahrain (.bh)
    #[serde(rename=".bh")] Bahrain,
    /// Burundi (.bi)
    #[serde(rename=".bi")] Burundi,
    /// Benin (.bj)
    #[serde(rename=".bj")] Benin,
    /// SaintBarthelemy (.bl)
    #[serde(rename=".bl")] SaintBarthelemy,
    /// Bermuda (.bm)
    #[serde(rename=".bm")] Bermuda,
    /// BruneiDarussalam (.bn)
    #[serde(rename=".bn")] BruneiDarussalam,
    /// Bolivia (.bo)
    #[serde(rename=".bo")] Bolivia,
    /// Bonaire (.bq)
    #[serde(rename=".bq")] BonaireSintEustatiusAndSaba,
    /// Brazil (.br)
    #[serde(rename=".br")] Brazil,
    /// Bahamas (.bs)
    #[serde(rename=".bs")] Bahamas,
    /// Bhutan (.bt)
    #[serde(rename=".bt")] Bhutan,
    /// BouvetIsland (.bv)
    #[serde(rename=".bv")] BouvetIsland,
    /// Botswana (.bw)
    #[serde(rename=".bw")] Botswana,
    /// Belarus (.by)
    #[serde(rename=".by")] Belarus,
    /// Belize (.bz)
    #[serde(rename=".bz")] Belize,
    /// Canada (.ca)
    #[serde(rename=".ca")] Canada,
    /// CocosIslands (.cc)
    #[serde(rename=".cc")] CocosIslands,
    /// DemocraticRepublicOfTheCongo (.cd)
    #[serde(rename=".cd")] DemocraticRepublicOfTheCongo,
    /// CentralAfricanRepublic (.cf)
    #[serde(rename=".cf")] CentralAfricanRepublic,
    /// RepublicOfCongo (.cg)
    #[serde(rename=".cg")] RepublicOfCongo,
    /// Switzerland (.ch)
    #[serde(rename=".ch")] Switzerland,
    /// CoteDivoire (.ci)
    #[serde(rename=".ci")] CoteDivoire,
    /// CookIslands (.ck)
    #[serde(rename=".ck")] CookIslands,
    /// Chile (.cl)
    #[serde(rename=".cl")] Chile,
    /// Cameroon (.cm)
    #[serde(rename=".cm")] Cameroon,
    /// China (.cn)
    #[serde(rename=".cn")] China,
    /// Colombia (.co)
    #[serde(rename=".co")] Colombia,
    /// CostaRica (.cr)
    #[serde(rename=".cr")] CostaRica,
    /// Cuba (.cu)
    #[serde(rename=".cu")] Cuba,
    /// CapeVerde (.cv)
    #[serde(rename=".cv")] CapeVerde,
    /// Curacao (.cw)
    #[serde(rename=".cw")] Curacao,
    /// ChristmasIsland (.cx)
    #[serde(rename=".cx")] ChristmasIsland,
    /// Cyprus (.cy)
    #[serde(rename=".cy")] Cyprus,
    /// CzechRepublic (.cz)
    #[serde(rename=".cz")] CzechRepublic,
    /// Germany (.de)
    #[serde(rename=".de")] Germany,
    /// Djibouti (.dj)
    #[serde(rename=".dj")] Djibouti,
    /// Denmark (.dk)
    #[serde(rename=".dk")] Denmark,
    /// Dominica (.dm)
    #[serde(rename=".dm")] Dominica,
    /// DominicanRepublic (.do)
    #[serde(rename=".do")] DominicanRepublic,
    /// Algeria (.dz)
    #[serde(rename=".dz")] Algeria,
    /// Ecuador (.ec)
    #[serde(rename=".ec")] Ecuador,
    /// Estonia (.ee)
    #[serde(rename=".ee")] Estonia,
    /// Egypt (.eg)
    #[serde(rename=".eg")] Egypt,
    /// WesternSahara (.eh)
    #[serde(rename=".eh")] WesternSahara,
    /// Eritrea (.er)
    #[serde(rename=".er")] Eritrea,
    /// Spain (.es)
    #[serde(rename=".es")] Spain,
    /// Ethiopia (.et)
    #[serde(rename=".et")] Ethiopia,
    /// EuropeanUnion (.eu)
    #[serde(rename=".eu")] EuropeanUnion,
    /// Finland (.fi)
    #[serde(rename=".fi")] Finland,
    /// Fiji (.fj)
    #[serde(rename=".fj")] Fiji,
    /// FalklandIslands (.fk)
    #[serde(rename=".fk")] FalklandIslands,
    /// FederatedStatesOfMicronesia (.fm)
    #[serde(rename=".fm")] FederatedStatesOfMicronesia,
    /// FaroeIslands (.fo)
    #[serde(rename=".fo")] FaroeIslands,
    /// France (.fr)
    #[serde(rename=".fr")] France,
    /// Gabon (.ga)
    #[serde(rename=".ga")] Gabon,
    /// Grenada (.gd)
    #[serde(rename=".gd")] Grenada,
    /// Georgia (.ge)
    #[serde(rename=".ge")] Georgia,
    /// FrenchGuiana (.gf)
    #[serde(rename=".gf")] FrenchGuiana,
    /// Guernsey (.gg)
    #[serde(rename=".gg")] Guernsey,
    /// Ghana (.gh)
    #[serde(rename=".gh")] Ghana,
    /// Gibraltar (.gi)
    #[serde(rename=".gi")] Gibraltar,
    /// Greenland (.gl)
    #[serde(rename=".gl")] Greenland,
    /// Gambia (.gm)
    #[serde(rename=".gm")] Gambia,
    /// Guinea (.gn)
    #[serde(rename=".gn")] Guinea,
    /// Guadeloupe (.gp)
    #[serde(rename=".gp")] Guadeloupe,
    /// EquatorialGuinea (.gq)
    #[serde(rename=".gq")] EquatorialGuinea,
    /// Greece (.gr)
    #[serde(rename=".gr")] Greece,
    /// SouthGeorgiaAndTheSouthSandwichIslands (.gs)
    #[serde(rename=".gs")] SouthGeorgiaAndTheSouthSandwichIslands,
    /// Guatemala (.gt)
    #[serde(rename=".gt")] Guatemala,
    /// Guam (.gu)
    #[serde(rename=".gu")] Guam,
    /// GuineaBissau (.gw)
    #[serde(rename=".gw")] GuineaBissau,
    /// Guyana (.gy)
    #[serde(rename=".gy")] Guyana,
    /// HongKong (.hk)
    #[serde(rename=".hk")] HongKong,
    /// HeardIslandAndMcDonaldIslands (.hm)
    #[serde(rename=".hm")] HeardIslandAndMcDonaldIslands,
    /// Honduras (.hn)
    #[serde(rename=".hn")] Honduras,
    /// Croatia (.hr)
    #[serde(rename=".hr")] Croatia,
    /// Haiti (.ht)
    #[serde(rename=".ht")] Haiti,
    /// Hungary (.hu)
    #[serde(rename=".hu")] Hungary,
    /// Indonesia (.id)
    #[serde(rename=".id")] Indonesia,
    /// Ireland (.ie)
    #[serde(rename=".ie")] Ireland,
    /// Israel (.il)
    #[serde(rename=".il")] Israel,
    /// IsleOfMan (.im)
    #[serde(rename=".im")] IsleOfMan,
    /// India (.in)
    #[serde(rename=".in")] India,
    /// BritishIndianOceanTerritory (.io)
    #[serde(rename=".io")] BritishIndianOceanTerritory,
    /// Iraq (.iq)
    #[serde(rename=".iq")] Iraq,
    /// IslamicRepublicOfIran (.ir)
    #[serde(rename=".ir")] IslamicRepublicOfIran,
    /// Iceland (.is)
    #[serde(rename=".is")] Iceland,
    /// Italy (.it)
    #[serde(rename=".it")] Italy,
    /// Jersey (.je)
    #[serde(rename=".je")] Jersey,
    /// Jamaica (.jm)
    #[serde(rename=".jm")] Jamaica,
    /// Jordan (.jo)
    #[serde(rename=".jo")] Jordan,
    /// Japan (.jp)
    #[serde(rename=".jp")] Japan,
    /// Kenya (.ke)
    #[serde(rename=".ke")] Kenya,
    /// Kyrgyzstan (.kg)
    #[serde(rename=".kg")] Kyrgyzstan,
    /// Cambodia (.kh)
    #[serde(rename=".kh")] Cambodia,
    /// Kiribati (.ki)
    #[serde(rename=".ki")] Kiribati,
    /// Comoros (.km)
    #[serde(rename=".km")] Comoros,
    /// SaintKittsAndNevis (.kn)
    #[serde(rename=".kn")] SaintKittsAndNevis,
    /// DemocraticPeoplesRepublicOfKorea (.kp)
    #[serde(rename=".kp")] DemocraticPeoplesRepublicOfKorea,
    /// RepublicOfKorea (.kp)
    #[serde(rename=".kp")] RepublicOfKorea,
    /// Kuwait (.kw)
    #[serde(rename=".kw")] Kuwait,
    /// CaymenIslands (.ky)
    #[serde(rename=".ky")] CaymenIslands,
    /// Kazakhstan (.kz)
    #[serde(rename=".kz")] Kazakhstan,
    /// Laos (.la)
    #[serde(rename=".la")] Laos,
    /// Lebanon (.lb)
    #[serde(rename=".lb")] Lebanon,
    /// SaintLucia (.lc)
    #[serde(rename=".lc")] SaintLucia,
    /// Liechtenstein (.li)
    #[serde(rename=".li")] Liechtenstein,
    /// SriLanka (.lk)
    #[serde(rename=".lk")] SriLanka,
    /// Liberia (.lr)
    #[serde(rename=".lr")] Liberia,
    /// Lesotho (.ls)
    #[serde(rename=".ls")] Lesotho,
    /// Lithuania (.lt)
    #[serde(rename=".lt")] Lithuania,
    /// Luxembourg (.lu)
    #[serde(rename=".lu")] Luxembourg,
    /// Latvia (.lv)
    #[serde(rename=".lv")] Latvia,
    /// Libya (.ly)
    #[serde(rename=".ly")] Libya,
    /// Morocco (.ma)
    #[serde(rename=".ma")] Morocco,
    /// Monaco (.mc)
    #[serde(rename=".mc")] Monaco,
    /// RepublicOfMoldova (.md)
    #[serde(rename=".md")] RepublicOfMoldova,
    /// Montenegro (.me)
    #[serde(rename=".me")] Montenegro,
    /// SaintMartin (.mf)
    #[serde(rename=".mf")] SaintMartin,
    /// Madagascar (.mg)
    #[serde(rename=".mg")] Madagascar,
    /// MarshallIslands (.mh)
    #[serde(rename=".mh")] MarshallIslands,
    /// Macedonia (.mk)
    #[serde(rename=".mk")] Macedonia,
    /// Mali (.ml)
    #[serde(rename=".ml")] Mali,
    /// Myanmar (.mm)
    #[serde(rename=".mm")] Myanmar,
    /// Mongolia (.mn)
    #[serde(rename=".mn")] Mongolia,
    /// Macao (.mo)
    #[serde(rename=".mo")] Macao,
    /// NorthernMarianaIslands (.mp)
    #[serde(rename=".mp")] NorthernMarianaIslands,
    /// Martinique (.mq)
    #[serde(rename=".mq")] Martinique,
    /// Mauritania (.mr)
    #[serde(rename=".mr")] Mauritania,
    /// Montserrat (.ms)
    #[serde(rename=".ms")] Montserrat,
    /// Malta (.mt)
    #[serde(rename=".mt")] Malta,
    /// Mauritius (.mu)
    #[serde(rename=".mu")] Mauritius,
    /// Maldives (.mv)
    #[serde(rename=".mv")] Maldives,
    /// Malawi (.mw)
    #[serde(rename=".mw")] Malawi,
    /// Mexico (.mx)
    #[serde(rename=".mx")] Mexico,
    /// Malaysia (.my)
    #[serde(rename=".my")] Malaysia,
    /// Mozambique (.mz)
    #[serde(rename=".mz")] Mozambique,
    /// Namibia (.na)
    #[serde(rename=".na")] Namibia,
    /// NewCaledonia (.nc)
    #[serde(rename=".nc")] NewCaledonia,
    /// Niger (.ne)
    #[serde(rename=".ne")] Niger,
    /// NorfolkIsland (.nf)
    #[serde(rename=".nf")] NorfolkIsland,
    /// Nigeria (.ng)
    #[serde(rename=".ng")] Nigeria,
    /// Nicaragua (.ni)
    #[serde(rename=".ni")] Nicaragua,
    /// Netherlands (.nl)
    #[serde(rename=".nl")] Netherlands,
    /// Norway (.no)
    #[serde(rename=".no")] Norway,
    /// Nepal (.np)
    #[serde(rename=".np")] Nepal,
    /// Nauru (.nr)
    #[serde(rename=".nr")] Nauru,
    /// Niue (.nu)
    #[serde(rename=".nu")] Niue,
    /// NewZealand (.nz)
    #[serde(rename=".nz")] NewZealand,
    /// Oman (.om)
    #[serde(rename=".om")] Oman,
    /// Panama (.pa)
    #[serde(rename=".pa")] Panama,
    /// Peru (.pe)
    #[serde(rename=".pe")] Peru,
    /// FrenchPolynesia (.pf)
    #[serde(rename=".pf")] FrenchPolynesia,
    /// PapuaNewGuinea (.pg)
    #[serde(rename=".pg")] PapuaNewGuinea,
    /// Philippines (.ph)
    #[serde(rename=".ph")] Philippines,
    /// Pakistan (.pk)
    #[serde(rename=".pk")] Pakistan,
    /// Poland (.pl)
    #[serde(rename=".pl")] Poland,
    /// SaintPierreAndMiquelon (.pm)
    #[serde(rename=".pm")] SaintPierreAndMiquelon,
    /// Pitcairn (.pn)
    #[serde(rename=".pn")] Pitcairn,
    /// PuertoRico (.pr)
    #[serde(rename=".pr")] PuertoRico,
    /// Palestine (.ps)
    #[serde(rename=".ps")] Palestine,
    /// Portugal (.pt)
    #[serde(rename=".pt")] Portugal,
    /// Palau (.pw)
    #[serde(rename=".pw")] Palau,
    /// Paraguay (.py)
    #[serde(rename=".py")] Paraguay,
    /// Qatar (.qa)
    #[serde(rename=".qa")] Qatar,
    /// Reunion (.re)
    #[serde(rename=".re")] Reunion,
    /// Romania (.ro)
    #[serde(rename=".ro")] Romania,
    /// Serbia (.rs)
    #[serde(rename=".rs")] Serbia,
    /// Russia (.ru)
    #[serde(rename=".ru")] Russia,
    /// Rwanda (.rw)
    #[serde(rename=".rw")] Rwanda,
    /// SaudiArabia (.sa)
    #[serde(rename=".sa")] SaudiArabia,
    /// SolomonIslands (.sb)
    #[serde(rename=".sb")] SolomonIslands,
    /// Seychelles (.sc)
    #[serde(rename=".sc")] Seychelles,
    /// Sudan (.sd)
    #[serde(rename=".sd")] Sudan,
    /// Sweden (.se)
    #[serde(rename=".se")] Sweden,
    /// Singapore (.sg)
    #[serde(rename=".sg")] Singapore,
    /// SaintHelena (.sh)
    #[serde(rename=".sh")] SaintHelena,
    /// Slovenia (.si)
    #[serde(rename=".si")] Slovenia,
    /// SvalbardAndJanMayen (.sj)
    #[serde(rename=".sj")] SvalbardAndJanMayen,
    /// Slovakia (.sk)
    #[serde(rename=".sk")] Slovakia,
    /// SierraLeone (.sl)
    #[serde(rename=".sl")] SierraLeone,
    /// SanMarino (.sm)
    #[serde(rename=".sm")] SanMarino,
    /// Senegal (.sn)
    #[serde(rename=".sn")] Senegal,
    /// Somalia (.so)
    #[serde(rename=".so")] Somalia,
    /// Suriname (.sr)
    #[serde(rename=".sr")] Suriname,
    /// SouthSudan (.ss)
    #[serde(rename=".ss")] SouthSudan,
    /// SaoTomeAndPrincipe (.st)
    #[serde(rename=".st")] SaoTomeAndPrincipe,
    /// SovietUnion (.su)
    #[serde(rename=".su")] SovietUnion,
    /// ElSalvador (.sv)
    #[serde(rename=".sv")] ElSalvador,
    /// SintMaarten (.sx)
    #[serde(rename=".sx")] SintMaarten,
    /// Syria (.sy)
    #[serde(rename=".sy")] Syria,
    /// Swaziland (.sz)
    #[serde(rename=".sz")] Swaziland,
    /// TurksAndCaicosIslands (.tc)
    #[serde(rename=".tc")] TurksAndCaicosIslands,
    /// Chad (.td)
    #[serde(rename=".td")] Chad,
    /// FrenchSouthernTerritories (.tf)
    #[serde(rename=".tf")] FrenchSouthernTerritories,
    /// Togo (.tg)
    #[serde(rename=".tg")] Togo,
    /// Thailand (.th)
    #[serde(rename=".th")] Thailand,
    /// Tajikistan (.tj)
    #[serde(rename=".tj")] Tajikistan,
    /// Tokelau (.tk)
    #[serde(rename=".tk")] Tokelau,
    /// TimorLeste (.tl)
    #[serde(rename=".tl")] TimorLeste,
    /// Turkmenistan (.tm)
    #[serde(rename=".tm")] Turkmenistan,
    /// Tunisia (.tn)
    #[serde(rename=".tn")] Tunisia,
    /// Tonga (.to)
    #[serde(rename=".to")] Tonga,
    /// PortugueseTimor (.tp)
    #[serde(rename=".tp")] PortugueseTimor,
    /// Turkey (.tr)
    #[serde(rename=".tr")] Turkey,
    /// TrinidadAndTobago (.tt)
    #[serde(rename=".tt")] TrinidadAndTobago,
    /// Tuvalu (.tv)
    #[serde(rename=".tv")] Tuvalu,
    /// Taiwan (.tw)
    #[serde(rename=".tw")] Taiwan,
    /// Tanzania (.tz)
    #[serde(rename=".tz")] Tanzania,
    /// Ukraine (.ua)
    #[serde(rename=".ua")] Ukraine,
    /// Uganda (.ug)
    #[serde(rename=".ug")] Uganda,
    /// UnitedKingdom (.uk)
    #[serde(rename=".uk")] UnitedKingdom,
    /// UnitedStatesMinorOutlyingIslands (.um)
    #[serde(rename=".um")] UnitedStatesMinorOutlyingIslands,
    /// UnitedStates (.us)
    #[serde(rename=".us")] UnitedStates,
    /// Uruguay (.uy)
    #[serde(rename=".uy")] Uruguay,
    /// Uzbekistan (.uz)
    #[serde(rename=".uz")] Uzbekistan,
    /// VaticanCity (.va)
    #[serde(rename=".va")] VaticanCity,
    /// SaintVincentAndTheGrenadines (.vc)
    #[serde(rename=".vc")] SaintVincentAndTheGrenadines,
    /// Venezuela (.ve)
    #[serde(rename=".ve")] Venezuela,
    /// BritishVirginIslands (.vg)
    #[serde(rename=".vg")] BritishVirginIslands,
    /// USVirginIslands (.vi)
    #[serde(rename=".vi")] USVirginIslands,
    /// Vietnam (.vn)
    #[serde(rename=".vn")] Vietnam,
    /// Vanuatu (.vu)
    #[serde(rename=".vu")] Vanuatu,
    /// WallisAndFutuna (.wf)
    #[serde(rename=".wf")] WallisAndFutuna,
    /// Samoa (.ws)
    #[serde(rename=".ws")] Samoa,
    /// Mayote (.yt)
    #[serde(rename=".yt")] Mayote,
    /// SouthAfrica (.za)
    #[serde(rename=".za")] SouthAfrica,
    /// Zambia (.zm)
    #[serde(rename=".zm")] Zambia,
    /// Zimbabwe (.zw)
    #[serde(rename=".zw")] Zimbabwe,
}

/// A rule for a component filter
#[derive(Debug,Eq,Hash,PartialEq)]
pub enum ComponentFilterRule {
    /// Matches postal_code and postal_code_prefix.
    PostalCode(String),
    /// Matches a country name or a two letter ISO 3166-1 country code. Note: The API follows the ISO standard for defining countries, and the filtering works best when using the corresponding ISO code of the country.
    Country(String),
    /// Matches the long or short name of a route.
    Route(String),
    /// Matches matches against locality and sublocality types.
    Locality(String),
    /// Matches all the administrative_area levels.
    AdministrativeArea(String),
}

impl Serialize for ComponentFilterRule {
    fn serialize<S>(&self, serializer: S) -> std::result::Result<S::Ok, S::Error> where S: Serializer {
        let v = match self {
            ComponentFilterRule::PostalCode(x)=>x,
            ComponentFilterRule::Country(x)=>x,
            ComponentFilterRule::Route(x)=>x,
            ComponentFilterRule::Locality(x)=>x,
            ComponentFilterRule::AdministrativeArea(x)=>x,
        };
        serializer.serialize_str(&format!("{}:{}", serde_util::variant_name(self), v))
    }
}

pub(crate) trait ApiQuery : Debug + Serialize {
}

/// Represents a connection to the Google geocoding API
pub struct Connection {
    client: Client,
}

impl Connection {
    const URL: &'static str = "https://maps.google.com/maps/api/geocode/json";

    /// Creates a new connection for the Google geocoding API on the specified reactor
    pub fn new(handle: &tokio_core::reactor::Handle) -> Self {
        Self {
            client: Client::new(handle)
        }
    }

    /// Get the address of the specified coordinates
    pub fn degeocode(&self, coordinates: impl Into<DegeocodeQuery>) -> impl Future<Item = Vec<Reply>, Error = Error> {
        self.get(coordinates.into())
    }

    /// Get the coordinates of the specified address
    pub fn geocode(&self, address: impl Into<GeocodeQuery>) -> impl Future<Item = Vec<Reply>, Error = Error> {
        self.get(address.into())
    }

    /// Perform the specified query
    fn get(&self, i_params: impl ApiQuery) -> impl Future<Item = Vec<Reply>, Error = Error> {
        // FIXME: unwrap below
        let mut url_full = Url::parse(Self::URL).unwrap();
        url_full.set_query(Some(serde_urlencoded::to_string(i_params).unwrap().as_ref()));
        self.client
            .get(url_full)
            .send()
            .map_err(Error::from)
            .and_then(move |res| res.into_body().concat2()
            .map_err(Error::from))
            .and_then(move |body| serde_json::from_slice(&body)
            .map_err(Error::from))
            .and_then(move |reply| {
                match reply {
                    ReplyResult { status: StatusCode::Ok, results, .. } => Ok(results),
                    ReplyResult { status: e, .. }  => Err(e.into()),
                }
            })
    }
}

/// WGS-84 coordinates that support serializing and deserializing
#[derive(Clone,Copy,Debug,Shrinkwrap)]
pub struct Coordinates(WGS84<f64>);

impl<'de> serde::Deserialize<'de> for Coordinates {
    fn deserialize<D>(deserializer: D) -> std::result::Result<Self, D::Error> 
    where D: Deserializer<'de> {
        #[derive(Deserialize)]
        pub struct Helper {
            #[serde(rename="lat")]
            latitude: f64,
            #[serde(rename="lng")]
            longitude: f64,
        }
        Helper::deserialize(deserializer)
            .and_then(|x|WGS84::try_new(x.latitude, x.longitude, 0f64).ok_or(serde::de::Error::custom(format!("Coordinates ({},{}) do not lie on WGS-84 ellipsoid", x.latitude, x.longitude))))
            .map(|x|Coordinates(x))
    }
}

impl Serialize for Coordinates {
    fn serialize<S>(&self, serializer: S) -> std::result::Result<S::Ok, S::Error> where S: Serializer {
        serializer.serialize_str(&self.to_string())
    }
}

impl std::fmt::Display for Coordinates {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        write!(f, "{},{}", self.0.latitude_degrees(), self.0.longitude_degrees())
    }
}

impl From<WGS84<f64>> for Coordinates {
    fn from(v: WGS84<f64>) -> Self {
        Coordinates(v)
    }
}


#[derive(Debug, Serialize)]
/// A query for an address
pub struct DegeocodeQuery {
    /// The latitude and longitude values specifying the location for which you wish to obtain the closest, human-readable address.
    #[serde(rename="latlng")]
    coordinates: Coordinates,

    /// The language in which to return results.
    language: Option<Language>,

    /// A filter of one or more address types.
    ///
    /// If the parameter contains multiple address types, the API returns all addresses that match any of the types.
    ///
    /// A note about processing: The result_type parameter does not restrict the search to the specified address type(s). Rather, the result_type acts as a post-search filter: the API fetches all results for the specified latlng, then discards those results that do not match the specified address type(s).
    ///
    /// Note: This parameter is available only for requests that include an API key or a client ID.
    result_type: Option<ApiSet<Type>>,

    /// A filter of one or more location types.
    ///
    /// If the parameter contains multiple location types, the API returns all addresses that match any of the types.
    ///
    /// A note about processing: The location_type parameter does not restrict the search to the specified location type(s). Rather, the location_type acts as a post-search filter: the API fetches all results for the specified latlng, then discards those results that do not match the specified location type(s).
    ///
    /// Note: This parameter is available only for requests that include an API key or a client ID.
    location_type: Option<ApiSet<LocationType>>,
}

impl DegeocodeQuery {
    /// Creates a new address query
    pub fn new(coordinates: impl Into<Coordinates>) -> Self {
        DegeocodeQuery {
            coordinates: coordinates.into(),
            language: None,
            location_type: None,
            result_type: None,
        }
    }

    /// The language in which to return results.
    pub fn language(mut self, i_language: Language) -> Self {
        self.language = Some(i_language);
        self
    }

    /// A filter of one or more location types.
    ///
    /// If the parameter contains multiple location types, the API returns all addresses that match any of the types.
    ///
    /// A note about processing: The location_type parameter does not restrict the search to the specified location type(s). Rather, the location_type acts as a post-search filter: the API fetches all results for the specified latlng, then discards those results that do not match the specified location type(s).
    ///
    /// Note: This parameter is available only for requests that include an API key or a client ID.
    pub fn location_type(mut self, i_location_type: ApiSet<LocationType>) -> Self {
        self.location_type = Some(i_location_type);
        self
    }

    /// A filter of one or more address types.
    ///
    /// If the parameter contains multiple address types, the API returns all addresses that match any of the types.
    ///
    /// A note about processing: The result_type parameter does not restrict the search to the specified address type(s). Rather, the result_type acts as a post-search filter: the API fetches all results for the specified latlng, then discards those results that do not match the specified address type(s).
    ///
    /// Note: This parameter is available only for requests that include an API key or a client ID.
    pub fn result_type(mut self, i_result_type: ApiSet<Type>) -> Self {
        self.result_type = Some(i_result_type);
        self
    }
}

impl<T> From<T> for DegeocodeQuery where Coordinates: From<T> {
    fn from(v: T) -> Self {
        Self::new(v)
    }
}

impl ApiQuery for DegeocodeQuery{}

/// A query for coordinates
#[derive(Debug, Serialize)]
pub struct GeocodeQuery {
    #[serde(flatten)]
    filter: Option<Place>,

    /// The bounding box of the viewport within which to bias geocode results more prominently.
    /// This parameter will only influence, not fully restrict, results from the geocoder.
    /// (For more information see Viewport Biasing below.)
    bounds: Option<Viewport>,

    /// The language in which to return results.
    language: Option<Language>,

    /// The region code.
    ///
    /// This parameter will only influence, not fully restrict, results from the geocoder.
    /// (For more information see Region Biasing below.)
    region: Option<Region>,
}

impl GeocodeQuery {
    /// Creates a new coordinates query
    pub fn new(filter: impl Into<Place>) -> Self {
        GeocodeQuery {
            filter: Some(filter.into()),
            //components: None,
            bounds: None,
            language: None,
            region: None,
        }
    }

    /// The bounding box of the viewport within which to bias geocode results more prominently.
    /// This parameter will only influence, not fully restrict, results from the geocoder.
    /// (For more information see Viewport Biasing below.)
    pub fn bounds(mut self, i_bounds: Viewport) -> Self {
        self.bounds = Some(i_bounds);
        self
    }

    /// The language in which to return results.
    pub fn language(mut self, i_language: Language) -> Self {
        self.language = Some(i_language);
        self
    }

    /// The region code.
    ///
    /// This parameter will only influence, not fully restrict, results from the geocoder.
    /// (For more information see Region Biasing below.)
    pub fn region(mut self, i_region: Region) -> Self {
        self.region = Some(i_region);
        self
    }
}

impl ApiQuery for GeocodeQuery{}

impl<T> From<T> for GeocodeQuery where Place: From<T> {
    fn from(v: T) -> Self {
        Self::new(v)
    }
}

/// An address in one of various formats
#[derive(Debug, Serialize)]
#[serde(untagged)]
pub enum Place {
    /// A specific place
    Address {
        /// The street address that you want to geocode,
        /// in the format used by the national postal service of the country concerned.
        /// Additional address elements such as business names and unit, suite or floor numbers should be avoided.
        /// Please refer to the FAQ for additional guidance. 
        address: String
    },
    /// The address broken down into components
    ComponentFilter {
        /// The components filter is required if the request doesn't include an address.
        /// Each element in the components filter consists of a component:value pair,
        /// and fully restricts the results from the geocoder.
        /// See more information about component filtering below.
        components: ApiSet<ComponentFilterRule>
    },
}

impl<T> From<T> for Place where T: Into<String> {
    fn from(s: T) -> Self {
        Place::Address { 
            address: s.into()
        }
    }
}

/// A unique identifier that can be used with other Google APIs.
/// For example, you can use the place_id in a Places SDK request to get details of a local business, such as phone number, opening hours, user reviews, and more. See the place ID overview.
#[derive(Debug,Deserialize,Eq,Hash,PartialEq,Serialize)]
pub struct PlaceId(String);

/// Get all the coordinates associated with the specified filter
pub fn geocode(address: impl Into<GeocodeQuery>) -> Result<impl Iterator<Item=Coordinates>> {
    let mut core = Core::new()?;
    let core_handle = core.handle();
    Ok(core.run(Connection::new(&core_handle).geocode(address))?.into_iter().map(|x|x.geometry.location))
}

/// Get all the addresses associated with the specified coordinates
pub fn degeocode(coordinates: impl Into<DegeocodeQuery>) -> Result<impl Iterator<Item=FormattedAddress>> {
    let mut core = Core::new()?;
    let core_handle = core.handle();
    Ok(core.run(Connection::new(&core_handle).degeocode(coordinates))?.into_iter().map(|x|x.formatted_address))
}

#[cfg(test)]
mod test {
    use super::*;

    const ADDRESS: &str = "1600 Amphitheatre Pkwy, Mountain View, CA 94043, USA";
    const COORDINATES: (f64, f64) = (37.42241, -122.08561);

    fn test_print<L>(i_label: L, i_rr: impl Future<Item = Vec<Reply>, Error=Error>) -> impl Future<Item=(),Error=()> 
        where L: Debug + 'static {
        let label = i_label;
        i_rr
            .map(move |rr| println!("{:#?}: {:#?}", label, rr.iter().map(|r|&r.geometry.location).collect::<Vec<_>>()))
            .map_err(|e| error!("{:?}", e))

    }

    fn test_start() -> (Core, Connection) {
        let core = Core::new().expect("Failed to initialize core");
        let connection = Connection::new(&core.handle());

        (core, connection)
    }

    fn test_stop<T>(mut i_core: Core, i_future: T)
        where T: futures::Future<Item=(), Error=()> {
        i_core.run(i_future).expect("Failed running tests")
    }

    #[test]
    fn address() {
        super::degeocode(WGS84::try_new(COORDINATES.0, COORDINATES.1, 0.0).unwrap()).unwrap();
    }

    #[test]
    fn coordinates() {
        super::geocode(ADDRESS).unwrap();
    }

    #[test]
    fn connection_both() {
        let (core, connection) = test_start();
        let tests = futures::Future::join(
            test_print("Basic", connection.geocode(ADDRESS)),
            test_print("Basic", connection.degeocode(
                WGS84::new(COORDINATES.0, COORDINATES.1, 0f64)
            )),
        ).map(|_|());
        test_stop(core, tests)
    }

    #[test]
    fn compare() {
        let mut coordinates = super::geocode(ADDRESS).unwrap();
        let first_coordinates = coordinates.next().unwrap();
        let mut addresses = super::degeocode(first_coordinates).unwrap();
        let first_address = addresses.next().unwrap();
        assert_eq!(ADDRESS, first_address.0);
    }

    #[test]
    fn connection_address() {
        let (core, connection) = test_start();
        let tests = test_print("address", connection.degeocode(WGS84::try_new(COORDINATES.0, COORDINATES.1, 0.0).unwrap()));
        test_stop(core, tests)
    }

    #[test]
    fn connection_coordinates() {
        let (core, connection) = test_start();
        let tests = test_print("coordinates", connection.geocode(ADDRESS));
        test_stop(core, tests)
    }

    /*
    #[test]
    fn languages() {
        let (core, connection) = test_start();

        let tests = futures::future::join_all(Language::iter().take(10).map(|l| {
            test_print(l, connection.get(GeocodeQuery::new(ADDRESS).language(l)))
        })).map(|_|());

        test_stop(core, tests)
    }

    #[test]
    fn regions() {
        let (core, connection) = test_start();

        let tests = futures::future::join_all(Region::iter().map(|cc| {
            test_print(cc, connection.get(GeocodeQuery::from_address(ADDRESS).region(cc)))
        })).map(|_|());

        test_stop(core, tests)
    }
    */
}