Feature/iterator

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "rust-analyzer.check.features": ["iterator", "with-serde"]
+}

Cargo.toml

@@ -14,10 +14,12 @@ keywords = ["currency", "iso", "iso-4217", "iso4217"]
 [features]
 default = []
 with-serde = ["serde"]
+iterator = ["strum"]
 
 [dependencies]
 iso_country = "0.1.4"
 serde = { version = "1.0.127", optional = true, features = ["derive"] }
+strum = {version = "0.25.0", optional = true, features = ["derive"] }
 
 [dev-dependencies]
 serde_json = "1.0.66"

README.md

@@ -15,10 +15,24 @@ The `Country` enum is re-exported from the only dependency - the [iso_country](h
 
 ## Features
 
-The crate has only one optional feature - `with-serde`. If you need serialization/deserialization support using `serde` you should include the feature in your dependency on `iso_currency`, for example like this:
+The crate has only two optional features:
 
-```toml
-iso_currency = { version = "0.4.3", features = ["with-serde"] }
+- `with-serde`
+- `iterator`
+
+### with-serde
+
+If you need serialization/deserialization support using `serde` you should include the feature in your dependency on `iso_currency`.
+
+This would derive serde's `Serialize` and `Deserialize` on `Currency`.
+
+### iterator
+
+If you specify the `iterator` feature on `iso_currency`, it will derive [strum's](https://crates.io/crates/strum) `EnumIter` trait on `Currency`, which provides an iterator over all variants of it. Here's an example usage:
+
+```rust
+use iso_currency::IntoEnumIterator;
+let mut iter = Currency::iter();
 ```
 
 ## Examples

build.rs

@@ -65,6 +65,11 @@ fn write_enum(file: &mut BufWriter<File>, data: &[IsoData]) {
         "#[cfg_attr(feature = \"with-serde\", derive(Serialize, Deserialize))]"
     )
     .unwrap();
+    writeln!(
+        file,
+        "#[cfg_attr(feature = \"iterator\", derive(EnumIter))]"
+    )
+    .unwrap();
     writeln!(
         file,
         "#[derive(Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord)]"

src/lib.rs

@@ -30,6 +30,11 @@ pub use iso_country::Country;
 #[cfg(feature = "with-serde")]
 use serde::{Deserialize, Serialize};
 
+#[cfg(feature = "iterator")]
+use strum::EnumIter;
+#[cfg(feature = "iterator")]
+pub use strum::IntoEnumIterator;
+
 include!(concat!(env!("OUT_DIR"), "/isodata.rs"));
 
 #[derive(PartialEq, Eq)]
@@ -105,8 +110,6 @@ impl std::str::FromStr for Currency {
 mod tests {
     use crate::{Country, Currency, ParseCurrencyError};
 
-    #[cfg(feature = "with-serde")]
-    use serde_json;
     #[cfg(feature = "with-serde")]
     use std::collections::HashMap;
 
@@ -216,4 +219,13 @@ mod tests {
         assert_eq!(Currency::from_str("BGN"), Ok(Currency::BGN));
         assert_eq!(Currency::from_str("AAA"), Err(ParseCurrencyError));
     }
+
+    #[test]
+    #[cfg(feature = "iterator")]
+    fn test_iterator() {
+        use crate::IntoEnumIterator;
+        let mut iter = Currency::iter();
+        assert_eq!(iter.next(), Some(Currency::AED));
+        assert_eq!(iter.next(), Some(Currency::AFN));
+    }
 }