Rename ErrorChainIter to Iter #168. (#196)

* Rename ErrorChainIter to Iter.

Fixes #168.

* Make ErrorChainIter's field private.

Fixes #178.

Author: ahmedcharles

CHANGELOG.md

@@ -1,5 +1,7 @@
 # Unreleased
 
+- [Make `ErrorChainIter`'s field private](https://github.com/brson/error-chain/issues/178)
+- [Rename `ErrorChainIter` to `Iter`](https://github.com/brson/error-chain/issues/168)
 - [Implement `Debug` for `ErrorChainIter`](https://github.com/brson/error-chain/issues/169)
 - [Rename `ChainedError::display` to `display_chain`](https://github.com/brson/error-chain/issues/180)
 - [Add a new method for `Error`: `chain_err`.](https://github.com/brson/error-chain/pull/141)

src/error_chain.rs

@@ -96,8 +96,8 @@ macro_rules! error_chain_processed {
                 self.kind()
             }
 
-            fn iter(&self) -> $crate::ErrorChainIter {
-                $crate::ErrorChainIter(Some(self))
+            fn iter(&self) -> $crate::Iter {
+                $crate::Iter::new(Some(self))
             }
 
             fn chain_err<F, EK>(self, error: F) -> Self
@@ -151,7 +151,7 @@ macro_rules! error_chain_processed {
             }
 
             /// Iterates over the error chain.
-            pub fn iter(&self) -> $crate::ErrorChainIter {
+            pub fn iter(&self) -> $crate::Iter {
                 $crate::ChainedError::iter(self)
             }
 

src/lib.rs

@@ -495,9 +495,16 @@ pub mod example_generated;
 
 #[derive(Debug)]
 /// Iterator over the error chain using the `Error::cause()` method.
-pub struct ErrorChainIter<'a>(pub Option<&'a error::Error>);
+pub struct Iter<'a>(Option<&'a error::Error>);
 
-impl<'a> Iterator for ErrorChainIter<'a> {
+impl<'a> Iter<'a> {
+    /// Returns a new iterator over the error chain using `Error::cause()`.
+    pub fn new(err: Option<&'a error::Error>) -> Iter<'a> {
+        Iter(err)
+    }
+}
+
+impl<'a> Iterator for Iter<'a> {
     type Item = &'a error::Error;
 
     fn next<'b>(&'b mut self) -> Option<&'a error::Error> {
@@ -542,7 +549,7 @@ pub trait ChainedError: error::Error + Send + 'static {
     fn kind(&self) -> &Self::ErrorKind;
 
     /// Iterates over the error chain.
-    fn iter(&self) -> ErrorChainIter;
+    fn iter(&self) -> Iter;
 
     /// Returns the backtrace associated with this error.
     fn backtrace(&self) -> Option<&Backtrace>;