1.0.0[][src]Trait core::iter::IntoIterator

pub trait IntoIterator {
    type Item;
    type IntoIter: Iterator<Item = Self::Item>;
    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();

assert_eq!(Some(1), iter.next());
assert_eq!(Some(2), iter.next());
assert_eq!(Some(3), iter.next());
assert_eq!(None, iter.next());Run

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);
}Run

It is common to use IntoIterator as a trait bound. This allows the input collection type to change, so long as it is still an iterator. Additional bounds can be specified by restricting on Item:

fn collect_as_strings<T>(collection: T) -> Vec<String>
    where T: IntoIterator,
          T::Item : std::fmt::Debug,
{
    collection
        .into_iter()
        .map(|item| format!("{:?}", item))
        .collect()
}Run

Associated Types

The type of the elements being iterated over.

Which kind of iterator are we turning this into?

Required Methods

Creates an iterator from a value.

See the module-level documentation for more.

Examples

Basic usage:

let v = vec![1, 2, 3];
let mut iter = v.into_iter();

assert_eq!(Some(1), iter.next());
assert_eq!(Some(2), iter.next());
assert_eq!(Some(3), iter.next());
assert_eq!(None, iter.next());Run

Implementors

impl<'a, T> IntoIterator for &'a Option<T>
[src]

Important traits for Iter<'a, A>

impl<'a, T> IntoIterator for &'a [T; 0]
[src]

Important traits for Iter<'a, T>

impl<'a, T> IntoIterator for &'a [T; 1]
[src]

Important traits for Iter<'a, T>

impl<'a, T> IntoIterator for &'a [T; 2]
[src]

Important traits for Iter<'a, T>

impl<'a, T> IntoIterator for &'a [T; 3]
[src]

Important traits for Iter<'a, T>

impl<'a, T> IntoIterator for &'a [T; 4]
[src]

Important traits for Iter<'a, T>

impl<'a, T> IntoIterator for &'a [T; 5]
[src]

Important traits for Iter<'a, T>

impl<'a, T> IntoIterator for &'a [T; 6]
[src]

Important traits for Iter<'a, T>

impl<'a, T> IntoIterator for &'a [T; 7]
[src]

Important traits for Iter<'a, T>

impl<'a, T> IntoIterator for &'a [T; 8]
[src]

Important traits for Iter<'a, T>

impl<'a, T> IntoIterator for &'a [T; 9]
[src]

Important traits for Iter<'a, T>

impl<'a, T> IntoIterator for &'a [T; 10]
[src]

Important traits for Iter<'a, T>

impl<'a, T> IntoIterator for &'a [T; 11]
[src]

Important traits for Iter<'a, T>

impl<'a, T> IntoIterator for &'a [T; 12]
[src]

Important traits for Iter<'a, T>

impl<'a, T> IntoIterator for &'a [T; 13]
[src]

Important traits for Iter<'a, T>

impl<'a, T> IntoIterator for &'a [T; 14]
[src]

Important traits for Iter<'a, T>

impl<'a, T> IntoIterator for &'a [T; 15]
[src]

Important traits for Iter<'a, T>

impl<'a, T> IntoIterator for &'a [T; 16]
[src]

Important traits for Iter<'a, T>

impl<'a, T> IntoIterator for &'a [T; 17]
[src]

Important traits for Iter<'a, T>

impl<'a, T> IntoIterator for &'a [T; 18]
[src]

Important traits for Iter<'a, T>

impl<'a, T> IntoIterator for &'a [T; 19]
[src]

Important traits for Iter<'a, T>

impl<'a, T> IntoIterator for &'a [T; 20]
[src]

Important traits for Iter<'a, T>

impl<'a, T> IntoIterator for &'a [T; 21]
[src]

Important traits for Iter<'a, T>

impl<'a, T> IntoIterator for &'a [T; 22]
[src]

Important traits for Iter<'a, T>

impl<'a, T> IntoIterator for &'a [T; 23]
[src]

Important traits for Iter<'a, T>

impl<'a, T> IntoIterator for &'a [T; 24]
[src]

Important traits for Iter<'a, T>

impl<'a, T> IntoIterator for &'a [T; 25]
[src]

Important traits for Iter<'a, T>

impl<'a, T> IntoIterator for &'a [T; 26]
[src]

Important traits for Iter<'a, T>

impl<'a, T> IntoIterator for &'a [T; 27]
[src]

Important traits for Iter<'a, T>

impl<'a, T> IntoIterator for &'a [T; 28]
[src]

Important traits for Iter<'a, T>

impl<'a, T> IntoIterator for &'a [T; 29]
[src]

Important traits for Iter<'a, T>

impl<'a, T> IntoIterator for &'a [T; 30]
[src]

Important traits for Iter<'a, T>

impl<'a, T> IntoIterator for &'a [T; 31]
[src]

Important traits for Iter<'a, T>

impl<'a, T> IntoIterator for &'a [T; 32]
[src]

Important traits for Iter<'a, T>

impl<'a, T> IntoIterator for &'a [T]
[src]

Important traits for Iter<'a, T>

impl<'a, T> IntoIterator for &'a mut Option<T>
[src]

Important traits for IterMut<'a, A>

impl<'a, T> IntoIterator for &'a mut [T; 0]
[src]

Important traits for IterMut<'a, T>

impl<'a, T> IntoIterator for &'a mut [T; 1]
[src]

Important traits for IterMut<'a, T>

impl<'a, T> IntoIterator for &'a mut [T; 2]
[src]

Important traits for IterMut<'a, T>

impl<'a, T> IntoIterator for &'a mut [T; 3]
[src]

Important traits for IterMut<'a, T>

impl<'a, T> IntoIterator for &'a mut [T; 4]
[src]

Important traits for IterMut<'a, T>

impl<'a, T> IntoIterator for &'a mut [T; 5]
[src]

Important traits for IterMut<'a, T>

impl<'a, T> IntoIterator for &'a mut [T; 6]
[src]

Important traits for IterMut<'a, T>

impl<'a, T> IntoIterator for &'a mut [T; 7]
[src]

Important traits for IterMut<'a, T>

impl<'a, T> IntoIterator for &'a mut [T; 8]
[src]

Important traits for IterMut<'a, T>

impl<'a, T> IntoIterator for &'a mut [T; 9]
[src]

Important traits for IterMut<'a, T>

impl<'a, T> IntoIterator for &'a mut [T; 10]
[src]

Important traits for IterMut<'a, T>

impl<'a, T> IntoIterator for &'a mut [T; 11]
[src]

Important traits for IterMut<'a, T>

impl<'a, T> IntoIterator for &'a mut [T; 12]
[src]

Important traits for IterMut<'a, T>

impl<'a, T> IntoIterator for &'a mut [T; 13]
[src]

Important traits for IterMut<'a, T>

impl<'a, T> IntoIterator for &'a mut [T; 14]
[src]

Important traits for IterMut<'a, T>

impl<'a, T> IntoIterator for &'a mut [T; 15]
[src]

Important traits for IterMut<'a, T>

impl<'a, T> IntoIterator for &'a mut [T; 16]
[src]

Important traits for IterMut<'a, T>

impl<'a, T> IntoIterator for &'a mut [T; 17]
[src]

Important traits for IterMut<'a, T>

impl<'a, T> IntoIterator for &'a mut [T; 18]
[src]

Important traits for IterMut<'a, T>

impl<'a, T> IntoIterator for &'a mut [T; 19]
[src]

Important traits for IterMut<'a, T>

impl<'a, T> IntoIterator for &'a mut [T; 20]
[src]

Important traits for IterMut<'a, T>

impl<'a, T> IntoIterator for &'a mut [T; 21]
[src]

Important traits for IterMut<'a, T>

impl<'a, T> IntoIterator for &'a mut [T; 22]
[src]

Important traits for IterMut<'a, T>

impl<'a, T> IntoIterator for &'a mut [T; 23]
[src]

Important traits for IterMut<'a, T>

impl<'a, T> IntoIterator for &'a mut [T; 24]
[src]

Important traits for IterMut<'a, T>

impl<'a, T> IntoIterator for &'a mut [T; 25]
[src]

Important traits for IterMut<'a, T>

impl<'a, T> IntoIterator for &'a mut [T; 26]
[src]

Important traits for IterMut<'a, T>

impl<'a, T> IntoIterator for &'a mut [T; 27]
[src]

Important traits for IterMut<'a, T>

impl<'a, T> IntoIterator for &'a mut [T; 28]
[src]

Important traits for IterMut<'a, T>

impl<'a, T> IntoIterator for &'a mut [T; 29]
[src]

Important traits for IterMut<'a, T>

impl<'a, T> IntoIterator for &'a mut [T; 30]
[src]

Important traits for IterMut<'a, T>

impl<'a, T> IntoIterator for &'a mut [T; 31]
[src]

Important traits for IterMut<'a, T>

impl<'a, T> IntoIterator for &'a mut [T; 32]
[src]

Important traits for IterMut<'a, T>

impl<'a, T> IntoIterator for &'a mut [T]
[src]

Important traits for IterMut<'a, T>

impl<'a, T, E> IntoIterator for &'a Result<T, E>
[src]

Important traits for Iter<'a, T>

impl<'a, T, E> IntoIterator for &'a mut Result<T, E>
[src]

Important traits for IterMut<'a, T>

impl<I: Iterator> IntoIterator for I
[src]

impl<T> IntoIterator for Option<T>
[src]

Important traits for IntoIter<A>

Returns a consuming iterator over the possibly contained value.

Examples

let x = Some("string");
let v: Vec<&str> = x.into_iter().collect();
assert_eq!(v, ["string"]);

let x = None;
let v: Vec<&str> = x.into_iter().collect();
assert!(v.is_empty());Run

impl<T, E> IntoIterator for Result<T, E>
[src]

Important traits for IntoIter<T>

Returns a consuming iterator over the possibly contained value.

The iterator yields one value if the result is Result::Ok, otherwise none.

Examples

Basic usage:

let x: Result<u32, &str> = Ok(5);
let v: Vec<u32> = x.into_iter().collect();
assert_eq!(v, [5]);

let x: Result<u32, &str> = Err("nothing!");
let v: Vec<u32> = x.into_iter().collect();
assert_eq!(v, []);Run