src/docs/iter_not_returning_iterator.txt

   1 ### What it does
   2 Detects methods named `iter` or `iter_mut` that do not have a return type that implements `Iterator`.
   3
   4 ### Why is this bad?
   5 Methods named `iter` or `iter_mut` conventionally return an `Iterator`.
   6
   7 ### Example
   8 ```
   9 // `String` does not implement `Iterator`
  10 struct Data {}
  11 impl Data {
  12     fn iter(&self) -> String {
  13         todo!()
  14     }
  15 }
  16 ```
  17 Use instead:
  18 ```
  19 use std::str::Chars;
  20 struct Data {}
  21 impl Data {
  22    fn iter(&self) -> Chars<'static> {
  23        todo!()
  24    }
  25 }
  26 ```