pub trait IntoIterator {
type Item;
type IntoIter: Iterator<Item = Self::Item>;
// Required method
fn into_iter(self) -> Self::IntoIter;
}
Expand description
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 = [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());
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<Self::Item>;
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);
}
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()
}
Required Associated Typesยง
Required Methodsยง
1.0.0 ยท Sourcefn into_iter(self) -> Self::IntoIter
fn into_iter(self) -> Self::IntoIter
Creates an iterator from a value.
See the module-level documentation for more.
ยงExamples
let v = [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());
Implementorsยง
Sourceยงimpl IntoIterator for IndexVec
impl IntoIterator for IndexVec
Sourceยงimpl IntoIterator for nix::fcntl::AtFlags
impl IntoIterator for nix::fcntl::AtFlags
Sourceยงimpl IntoIterator for nix::fcntl::FallocateFlags
impl IntoIterator for nix::fcntl::FallocateFlags
type Item = FallocateFlags
type IntoIter = Iter<FallocateFlags>
Sourceยงimpl IntoIterator for nix::fcntl::RenameFlags
impl IntoIterator for nix::fcntl::RenameFlags
type Item = RenameFlags
type IntoIter = Iter<RenameFlags>
Sourceยงimpl IntoIterator for ResolveFlag
impl IntoIterator for ResolveFlag
type Item = ResolveFlag
type IntoIter = Iter<ResolveFlag>
Sourceยงimpl IntoIterator for SealFlag
impl IntoIterator for SealFlag
Sourceยงimpl IntoIterator for MemFdCreateFlag
impl IntoIterator for MemFdCreateFlag
type Item = MemFdCreateFlag
type IntoIter = Iter<MemFdCreateFlag>
Sourceยงimpl IntoIterator for SaFlags
impl IntoIterator for SaFlags
Sourceยงimpl IntoIterator for SfdFlags
impl IntoIterator for SfdFlags
Sourceยงimpl IntoIterator for nix::sys::stat::Mode
impl IntoIterator for nix::sys::stat::Mode
Sourceยงimpl IntoIterator for FsFlags
impl IntoIterator for FsFlags
Sourceยงimpl IntoIterator for WaitPidFlag
impl IntoIterator for WaitPidFlag
type Item = WaitPidFlag
type IntoIter = Iter<WaitPidFlag>
Sourceยงimpl IntoIterator for AccessFlags
impl IntoIterator for AccessFlags
type Item = AccessFlags
type IntoIter = Iter<AccessFlags>
Sourceยงimpl IntoIterator for regex::regexset::bytes::SetMatches
impl IntoIterator for regex::regexset::bytes::SetMatches
Sourceยงimpl IntoIterator for regex::regexset::string::SetMatches
impl IntoIterator for regex::regexset::string::SetMatches
Sourceยงimpl IntoIterator for CreateFlags
impl IntoIterator for CreateFlags
type Item = CreateFlags
type IntoIter = Iter<CreateFlags>
Sourceยงimpl IntoIterator for ReadFlags
impl IntoIterator for ReadFlags
Sourceยงimpl IntoIterator for WatchFlags
impl IntoIterator for WatchFlags
type Item = WatchFlags
type IntoIter = Iter<WatchFlags>
Sourceยงimpl IntoIterator for rustix::backend::fs::types::AtFlags
impl IntoIterator for rustix::backend::fs::types::AtFlags
Sourceยงimpl IntoIterator for rustix::backend::fs::types::FallocateFlags
impl IntoIterator for rustix::backend::fs::types::FallocateFlags
type Item = FallocateFlags
type IntoIter = Iter<FallocateFlags>
Sourceยงimpl IntoIterator for MemfdFlags
impl IntoIterator for MemfdFlags
type Item = MemfdFlags
type IntoIter = Iter<MemfdFlags>
Sourceยงimpl IntoIterator for rustix::backend::fs::types::Mode
impl IntoIterator for rustix::backend::fs::types::Mode
Sourceยงimpl IntoIterator for rustix::backend::fs::types::RenameFlags
impl IntoIterator for rustix::backend::fs::types::RenameFlags
type Item = RenameFlags
type IntoIter = Iter<RenameFlags>
Sourceยงimpl IntoIterator for ResolveFlags
impl IntoIterator for ResolveFlags
type Item = ResolveFlags
type IntoIter = Iter<ResolveFlags>
Sourceยงimpl IntoIterator for SealFlags
impl IntoIterator for SealFlags
Sourceยงimpl IntoIterator for StatVfsMountFlags
impl IntoIterator for StatVfsMountFlags
type Item = StatVfsMountFlags
type IntoIter = Iter<StatVfsMountFlags>
Sourceยงimpl IntoIterator for StatxFlags
impl IntoIterator for StatxFlags
type Item = StatxFlags
type IntoIter = Iter<StatxFlags>
Sourceยงimpl IntoIterator for DupFlags
impl IntoIterator for DupFlags
Sourceยงimpl IntoIterator for FdFlags
impl IntoIterator for FdFlags
Sourceยงimpl IntoIterator for ReadWriteFlags
impl IntoIterator for ReadWriteFlags
type Item = ReadWriteFlags
type IntoIter = Iter<ReadWriteFlags>
Sourceยงimpl IntoIterator for MountFlags
impl IntoIterator for MountFlags
type Item = MountFlags
type IntoIter = Iter<MountFlags>
Sourceยงimpl IntoIterator for UnmountFlags
impl IntoIterator for UnmountFlags
type Item = UnmountFlags
type IntoIter = Iter<UnmountFlags>
Sourceยงimpl IntoIterator for XattrFlags
impl IntoIterator for XattrFlags
type Item = XattrFlags
type IntoIter = Iter<XattrFlags>
Sourceยงimpl IntoIterator for ControlModes
impl IntoIterator for ControlModes
type Item = ControlModes
type IntoIter = Iter<ControlModes>
Sourceยงimpl IntoIterator for InputModes
impl IntoIterator for InputModes
type Item = InputModes
type IntoIter = Iter<InputModes>
Sourceยงimpl IntoIterator for LocalModes
impl IntoIterator for LocalModes
type Item = LocalModes
type IntoIter = Iter<LocalModes>
Sourceยงimpl IntoIterator for OutputModes
impl IntoIterator for OutputModes
type Item = OutputModes
type IntoIter = Iter<OutputModes>
Sourceยงimpl<'a> IntoIterator for &'a Utf8Sequence
impl<'a> IntoIterator for &'a Utf8Sequence
1.6.0 ยท Sourceยงimpl<'a> IntoIterator for &'a Path
impl<'a> IntoIterator for &'a Path
1.6.0 ยท Sourceยงimpl<'a> IntoIterator for &'a PathBuf
impl<'a> IntoIterator for &'a PathBuf
Sourceยงimpl<'a> IntoIterator for &'a Utf8Path
impl<'a> IntoIterator for &'a Utf8Path
1.10.0 ยท Sourceยงimpl<'a> IntoIterator for &'a UnixListener
impl<'a> IntoIterator for &'a UnixListener
Sourceยงimpl<'a> IntoIterator for &'a Params
impl<'a> IntoIterator for &'a Params
Sourceยงimpl<'a> IntoIterator for &'a Utf8PathBuf
impl<'a> IntoIterator for &'a Utf8PathBuf
Sourceยงimpl<'a> IntoIterator for &'a SigSet
impl<'a> IntoIterator for &'a SigSet
Sourceยงimpl<'a> IntoIterator for &'a regex::regexset::bytes::SetMatches
impl<'a> IntoIterator for &'a regex::regexset::bytes::SetMatches
Sourceยงimpl<'a> IntoIterator for &'a regex::regexset::string::SetMatches
impl<'a> IntoIterator for &'a regex::regexset::string::SetMatches
1.0.0 ยท Sourceยงimpl<'a, K, V, A> IntoIterator for &'a BTreeMap<K, V, A>
impl<'a, K, V, A> IntoIterator for &'a BTreeMap<K, V, A>
1.0.0 ยท Sourceยงimpl<'a, K, V, A> IntoIterator for &'a mut BTreeMap<K, V, A>
impl<'a, K, V, A> IntoIterator for &'a mut BTreeMap<K, V, A>
1.0.0 ยท Sourceยงimpl<'a, K, V, S> IntoIterator for &'a HashMap<K, V, S>
impl<'a, K, V, S> IntoIterator for &'a HashMap<K, V, S>
1.0.0 ยท Sourceยงimpl<'a, K, V, S> IntoIterator for &'a mut HashMap<K, V, S>
impl<'a, K, V, S> IntoIterator for &'a mut HashMap<K, V, S>
1.4.0 ยท Sourceยงimpl<'a, T> IntoIterator for &'a Option<T>
impl<'a, T> IntoIterator for &'a Option<T>
1.0.0 ยท Sourceยงimpl<'a, T> IntoIterator for &'a [T]
impl<'a, T> IntoIterator for &'a [T]
Sourceยงimpl<'a, T> IntoIterator for &'a std::sync::mpmc::Receiver<T>
impl<'a, T> IntoIterator for &'a std::sync::mpmc::Receiver<T>
1.1.0 ยท Sourceยงimpl<'a, T> IntoIterator for &'a std::sync::mpsc::Receiver<T>
impl<'a, T> IntoIterator for &'a std::sync::mpsc::Receiver<T>
1.4.0 ยท Sourceยงimpl<'a, T> IntoIterator for &'a mut Option<T>
impl<'a, T> IntoIterator for &'a mut Option<T>
1.0.0 ยท Sourceยงimpl<'a, T> IntoIterator for &'a mut [T]
impl<'a, T> IntoIterator for &'a mut [T]
1.0.0 ยท Sourceยงimpl<'a, T, A> IntoIterator for &'a BTreeSet<T, A>
impl<'a, T, A> IntoIterator for &'a BTreeSet<T, A>
1.0.0 ยท Sourceยงimpl<'a, T, A> IntoIterator for &'a Vec<T, A>where
A: Allocator,
impl<'a, T, A> IntoIterator for &'a Vec<T, A>where
A: Allocator,
1.0.0 ยท Sourceยงimpl<'a, T, A> IntoIterator for &'a BinaryHeap<T, A>where
A: Allocator,
impl<'a, T, A> IntoIterator for &'a BinaryHeap<T, A>where
A: Allocator,
1.0.0 ยท Sourceยงimpl<'a, T, A> IntoIterator for &'a LinkedList<T, A>where
A: Allocator,
impl<'a, T, A> IntoIterator for &'a LinkedList<T, A>where
A: Allocator,
1.0.0 ยท Sourceยงimpl<'a, T, A> IntoIterator for &'a VecDeque<T, A>where
A: Allocator,
impl<'a, T, A> IntoIterator for &'a VecDeque<T, A>where
A: Allocator,
1.0.0 ยท Sourceยงimpl<'a, T, A> IntoIterator for &'a mut Vec<T, A>where
A: Allocator,
impl<'a, T, A> IntoIterator for &'a mut Vec<T, A>where
A: Allocator,
1.0.0 ยท Sourceยงimpl<'a, T, A> IntoIterator for &'a mut LinkedList<T, A>where
A: Allocator,
impl<'a, T, A> IntoIterator for &'a mut LinkedList<T, A>where
A: Allocator,
1.0.0 ยท Sourceยงimpl<'a, T, A> IntoIterator for &'a mut VecDeque<T, A>where
A: Allocator,
impl<'a, T, A> IntoIterator for &'a mut VecDeque<T, A>where
A: Allocator,
1.4.0 ยท Sourceยงimpl<'a, T, E> IntoIterator for &'a Result<T, E>
impl<'a, T, E> IntoIterator for &'a Result<T, E>
1.4.0 ยท Sourceยงimpl<'a, T, E> IntoIterator for &'a mut Result<T, E>
impl<'a, T, E> IntoIterator for &'a mut Result<T, E>
Sourceยงimpl<'a, T, N> IntoIterator for &'a GenericArray<T, N>where
T: 'a,
N: ArrayLength<T>,
impl<'a, T, N> IntoIterator for &'a GenericArray<T, N>where
T: 'a,
N: ArrayLength<T>,
Sourceยงimpl<'a, T, N> IntoIterator for &'a mut GenericArray<T, N>where
T: 'a,
N: ArrayLength<T>,
impl<'a, T, N> IntoIterator for &'a mut GenericArray<T, N>where
T: 'a,
N: ArrayLength<T>,
1.0.0 ยท Sourceยงimpl<'a, T, S> IntoIterator for &'a HashSet<T, S>
impl<'a, T, S> IntoIterator for &'a HashSet<T, S>
Sourceยงimpl<'a, T, const CAP: usize> IntoIterator for &'a ArrayVec<T, CAP>where
T: 'a,
Iterate the ArrayVec
with references to each element.
impl<'a, T, const CAP: usize> IntoIterator for &'a ArrayVec<T, CAP>where
T: 'a,
Iterate the ArrayVec
with references to each element.
use arrayvec::ArrayVec;
let array = ArrayVec::from([1, 2, 3]);
for elt in &array {
// ...
}
Sourceยงimpl<'a, T, const CAP: usize> IntoIterator for &'a mut ArrayVec<T, CAP>where
T: 'a,
Iterate the ArrayVec
with mutable references to each element.
impl<'a, T, const CAP: usize> IntoIterator for &'a mut ArrayVec<T, CAP>where
T: 'a,
Iterate the ArrayVec
with mutable references to each element.
use arrayvec::ArrayVec;
let mut array = ArrayVec::from([1, 2, 3]);
for elt in &mut array {
// ...
}
1.0.0 ยท Sourceยงimpl<'a, T, const N: usize> IntoIterator for &'a [T; N]
impl<'a, T, const N: usize> IntoIterator for &'a [T; N]
1.0.0 ยท Sourceยงimpl<'a, T, const N: usize> IntoIterator for &'a mut [T; N]
impl<'a, T, const N: usize> IntoIterator for &'a mut [T; N]
Sourceยงimpl<'key, V: Keyed<'key>> IntoIterator for Table<'key, V>
impl<'key, V: Keyed<'key>> IntoIterator for Table<'key, V>
Sourceยงimpl<'table, V: Keyed<'table> + 'table> IntoIterator for &'table Table<'table, V>
impl<'table, V: Keyed<'table> + 'table> IntoIterator for &'table Table<'table, V>
Sourceยงimpl<A> IntoIterator for Range<A>where
A: Step,
impl<A> IntoIterator for Range<A>where
A: Step,
Sourceยงimpl<A> IntoIterator for RangeFrom<A>where
A: Step,
impl<A> IntoIterator for RangeFrom<A>where
A: Step,
Sourceยงimpl<A> IntoIterator for RangeInclusive<A>where
A: Step,
impl<A> IntoIterator for RangeInclusive<A>where
A: Step,
1.0.0 ยท Sourceยงimpl<I> IntoIterator for Iwhere
I: Iterator,
impl<I> IntoIterator for Iwhere
I: Iterator,
1.0.0 ยท Sourceยงimpl<K, V, A> IntoIterator for BTreeMap<K, V, A>
impl<K, V, A> IntoIterator for BTreeMap<K, V, A>
1.0.0 ยท Sourceยงimpl<K, V, S> IntoIterator for HashMap<K, V, S>
impl<K, V, S> IntoIterator for HashMap<K, V, S>
1.0.0 ยท Sourceยงimpl<T> IntoIterator for Option<T>
impl<T> IntoIterator for Option<T>
Sourceยงimpl<T> IntoIterator for std::sync::mpmc::Receiver<T>
impl<T> IntoIterator for std::sync::mpmc::Receiver<T>
1.1.0 ยท Sourceยงimpl<T> IntoIterator for std::sync::mpsc::Receiver<T>
impl<T> IntoIterator for std::sync::mpsc::Receiver<T>
1.0.0 ยท Sourceยงimpl<T, A> IntoIterator for BTreeSet<T, A>
impl<T, A> IntoIterator for BTreeSet<T, A>
1.0.0 ยท Sourceยงimpl<T, A> IntoIterator for Vec<T, A>where
A: Allocator,
impl<T, A> IntoIterator for Vec<T, A>where
A: Allocator,
1.0.0 ยท Sourceยงimpl<T, A> IntoIterator for BinaryHeap<T, A>where
A: Allocator,
impl<T, A> IntoIterator for BinaryHeap<T, A>where
A: Allocator,
1.0.0 ยท Sourceยงimpl<T, A> IntoIterator for LinkedList<T, A>where
A: Allocator,
impl<T, A> IntoIterator for LinkedList<T, A>where
A: Allocator,
1.0.0 ยท Sourceยงimpl<T, A> IntoIterator for VecDeque<T, A>where
A: Allocator,
impl<T, A> IntoIterator for VecDeque<T, A>where
A: Allocator,
1.0.0 ยท Sourceยงimpl<T, E> IntoIterator for Result<T, E>
impl<T, E> IntoIterator for Result<T, E>
Sourceยงimpl<T, N> IntoIterator for GenericArray<T, N>where
N: ArrayLength<T>,
impl<T, N> IntoIterator for GenericArray<T, N>where
N: ArrayLength<T>,
1.0.0 ยท Sourceยงimpl<T, S> IntoIterator for HashSet<T, S>
impl<T, S> IntoIterator for HashSet<T, S>
Sourceยงimpl<T, const CAP: usize> IntoIterator for ArrayVec<T, CAP>
Iterate the ArrayVec
with each element by value.
impl<T, const CAP: usize> IntoIterator for ArrayVec<T, CAP>
Iterate the ArrayVec
with each element by value.
The vector is consumed by this operation.
use arrayvec::ArrayVec;
for elt in ArrayVec::from([1, 2, 3]) {
// ...
}