std::iter::IntoIterator

Trait std::iter::IntoIterator

pub trait IntoIterator where    <Self::IntoIter as Iterator>::Item == Self::Item, {
    type Item;
    type IntoIter: Iterator;
    fn into_iter(self) -> Self::IntoIter;
}

Conversion into an Iterator.

By implementing IntoIterator for a type, you define how it will be converted to an iterator. This is common for types which describe a collection of some kind.

One benefit of implementing IntoIterator is that your type will work with Rust's for loop syntax.

See also: FromIterator.

Examples

Basic usage:

let v = vec![1, 2, 3];

let mut iter = v.into_iter();

let n = iter.next();
assert_eq!(Some(1), n);

let n = iter.next();
assert_eq!(Some(2), n);

let n = iter.next();
assert_eq!(Some(3), n);

let n = iter.next();
assert_eq!(None, n);

Implementing IntoIterator for your type:

// A sample collection, that's just a wrapper over Vec<T>
#[derive(Debug)]
struct MyCollection(Vec<i32>);

// Let's give it some methods so we can create one and add things
// to it.
impl MyCollection {
    fn new() -> MyCollection {
        MyCollection(Vec::new())
    }

    fn add(&mut self, elem: i32) {
        self.0.push(elem);
    }
}

// and we'll implement IntoIterator
impl IntoIterator for MyCollection {
    type Item = i32;
    type IntoIter = ::std::vec::IntoIter<i32>;

    fn into_iter(self) -> Self::IntoIter {
        self.0.into_iter()
    }
}

// Now we can make a new collection...
let mut c = MyCollection::new();

// ... add some stuff to it ...
c.add(0);
c.add(1);
c.add(2);

// ... and then turn it into an Iterator:
for (i, n) in c.into_iter().enumerate() {
    assert_eq!(i as i32, n);
}

Associated Types

Required Methods

let v = vec![1, 2, 3];

let mut iter = v.into_iter();

let n = iter.next();
assert_eq!(Some(1), n);

let n = iter.next();
assert_eq!(Some(2), n);

let n = iter.next();
assert_eq!(Some(3), n);

let n = iter.next();
assert_eq!(None, n);

Implementors

• impl<T> IntoIterator for BinaryHeap<T> where
    T: Ord, 
• impl<'a, T> IntoIterator for &'a BinaryHeap<T> where
    T: Ord, 
• impl<'a, K, V> IntoIterator for &'a BTreeMap<K, V> where
    K: 'a,
    V: 'a, 
• impl<'a, K, V> IntoIterator for &'a mut BTreeMap<K, V> where
    K: 'a,
    V: 'a, 
• impl<K, V> IntoIterator for BTreeMap<K, V>
• impl<T> IntoIterator for BTreeSet<T>
• impl<'a, T> IntoIterator for &'a BTreeSet<T>
• impl<T> IntoIterator for LinkedList<T>
• impl<'a, T> IntoIterator for &'a LinkedList<T>
• impl<'a, T> IntoIterator for &'a mut LinkedList<T>
• impl<T> IntoIterator for Vec<T>
• impl<'a, T> IntoIterator for &'a Vec<T>
• impl<'a, T> IntoIterator for &'a mut Vec<T>
• impl<T> IntoIterator for VecDeque<T>
• impl<'a, T> IntoIterator for &'a VecDeque<T>
• impl<'a, T> IntoIterator for &'a mut VecDeque<T>
• impl<I> IntoIterator for I where
    I: Iterator, 
• impl<T> IntoIterator for Option<T>
• impl<'a, T> IntoIterator for &'a Option<T>
• impl<'a, T> IntoIterator for &'a mut Option<T>
• impl<T, E> IntoIterator for Result<T, E>
• impl<'a, T, E> IntoIterator for &'a Result<T, E>
• impl<'a, T, E> IntoIterator for &'a mut Result<T, E>
• impl<'a, T> IntoIterator for &'a [T]
• impl<'a, T> IntoIterator for &'a mut [T]
• impl<'a, T> IntoIterator for &'a [T; 0]
• impl<'a, T> IntoIterator for &'a mut [T; 0]
• impl<'a, T> IntoIterator for &'a [T; 1]
• impl<'a, T> IntoIterator for &'a mut [T; 1]
• impl<'a, T> IntoIterator for &'a [T; 2]
• impl<'a, T> IntoIterator for &'a mut [T; 2]
• impl<'a, T> IntoIterator for &'a [T; 3]
• impl<'a, T> IntoIterator for &'a mut [T; 3]
• impl<'a, T> IntoIterator for &'a [T; 4]
• impl<'a, T> IntoIterator for &'a mut [T; 4]
• impl<'a, T> IntoIterator for &'a [T; 5]
• impl<'a, T> IntoIterator for &'a mut [T; 5]
• impl<'a, T> IntoIterator for &'a [T; 6]
• impl<'a, T> IntoIterator for &'a mut [T; 6]
• impl<'a, T> IntoIterator for &'a [T; 7]
• impl<'a, T> IntoIterator for &'a mut [T; 7]
• impl<'a, T> IntoIterator for &'a [T; 8]
• impl<'a, T> IntoIterator for &'a mut [T; 8]
• impl<'a, T> IntoIterator for &'a [T; 9]
• impl<'a, T> IntoIterator for &'a mut [T; 9]
• impl<'a, T> IntoIterator for &'a [T; 10]
• impl<'a, T> IntoIterator for &'a mut [T; 10]
• impl<'a, T> IntoIterator for &'a [T; 11]
• impl<'a, T> IntoIterator for &'a mut [T; 11]
• impl<'a, T> IntoIterator for &'a [T; 12]
• impl<'a, T> IntoIterator for &'a mut [T; 12]
• impl<'a, T> IntoIterator for &'a [T; 13]
• impl<'a, T> IntoIterator for &'a mut [T; 13]
• impl<'a, T> IntoIterator for &'a [T; 14]
• impl<'a, T> IntoIterator for &'a mut [T; 14]
• impl<'a, T> IntoIterator for &'a [T; 15]
• impl<'a, T> IntoIterator for &'a mut [T; 15]
• impl<'a, T> IntoIterator for &'a [T; 16]
• impl<'a, T> IntoIterator for &'a mut [T; 16]
• impl<'a, T> IntoIterator for &'a [T; 17]
• impl<'a, T> IntoIterator for &'a mut [T; 17]
• impl<'a, T> IntoIterator for &'a [T; 18]
• impl<'a, T> IntoIterator for &'a mut [T; 18]
• impl<'a, T> IntoIterator for &'a [T; 19]
• impl<'a, T> IntoIterator for &'a mut [T; 19]
• impl<'a, T> IntoIterator for &'a [T; 20]
• impl<'a, T> IntoIterator for &'a mut [T; 20]
• impl<'a, T> IntoIterator for &'a [T; 21]
• impl<'a, T> IntoIterator for &'a mut [T; 21]
• impl<'a, T> IntoIterator for &'a [T; 22]
• impl<'a, T> IntoIterator for &'a mut [T; 22]
• impl<'a, T> IntoIterator for &'a [T; 23]
• impl<'a, T> IntoIterator for &'a mut [T; 23]
• impl<'a, T> IntoIterator for &'a [T; 24]
• impl<'a, T> IntoIterator for &'a mut [T; 24]
• impl<'a, T> IntoIterator for &'a [T; 25]
• impl<'a, T> IntoIterator for &'a mut [T; 25]
• impl<'a, T> IntoIterator for &'a [T; 26]
• impl<'a, T> IntoIterator for &'a mut [T; 26]
• impl<'a, T> IntoIterator for &'a [T; 27]
• impl<'a, T> IntoIterator for &'a mut [T; 27]
• impl<'a, T> IntoIterator for &'a [T; 28]
• impl<'a, T> IntoIterator for &'a mut [T; 28]
• impl<'a, T> IntoIterator for &'a [T; 29]
• impl<'a, T> IntoIterator for &'a mut [T; 29]
• impl<'a, T> IntoIterator for &'a [T; 30]
• impl<'a, T> IntoIterator for &'a mut [T; 30]
• impl<'a, T> IntoIterator for &'a [T; 31]
• impl<'a, T> IntoIterator for &'a mut [T; 31]
• impl<'a, T> IntoIterator for &'a [T; 32]
• impl<'a, T> IntoIterator for &'a mut [T; 32]
• impl<'a, K, V, S> IntoIterator for &'a HashMap<K, V, S> where
    K: Eq + Hash,
    S: BuildHasher, 
• impl<'a, K, V, S> IntoIterator for &'a mut HashMap<K, V, S> where
    K: Eq + Hash,
    S: BuildHasher, 
• impl<K, V, S> IntoIterator for HashMap<K, V, S> where
    K: Eq + Hash,
    S: BuildHasher, 
• impl<'a, T, S> IntoIterator for &'a HashSet<T, S> where
    T: Eq + Hash,
    S: BuildHasher, 
• impl<T, S> IntoIterator for HashSet<T, S> where
    T: Eq + Hash,
    S: BuildHasher, 
• impl<'a> IntoIterator for &'a PathBuf
• impl<'a> IntoIterator for &'a Path
• impl<'a, T> IntoIterator for &'a Receiver<T>
• impl<T> IntoIterator for Receiver<T>
• impl<'a> IntoIterator for &'a UnixListener