devela::_dep::bytemuck::__core::iter

Trait IntoIterator

Help

1.6.0 · Source

pub trait IntoIterator {
    type Item;
    type IntoIter: Iterator<Item = Self::Item>;

    // Required method
    fn into_iter(self) -> Self::IntoIter;
}

Available on crate feature dep_bytemuck only.

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.

§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§

1.0.0 · Source

type Item

The type of the elements being iterated over.

1.0.0 · Source

type IntoIter: Iterator<Item = Self::Item>

Which kind of iterator are we turning this into?

Required Methods§

1.0.0 · Source

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§

§

impl IntoIterator for SingleWindow

Trait IntoIteratorCopy item path

§Examples

Required Associated Types§

type Item

type IntoIter: Iterator<Item = Self::Item>

Required Methods§

fn into_iter(self) -> Self::IntoIter

§Examples

Implementors§

impl IntoIterator for KeyEventState

type Item = KeyEventState

type IntoIter = Iter<KeyEventState>

impl IntoIterator for KeyModifiers

type Item = KeyModifiers

type IntoIter = Iter<KeyModifiers>

impl IntoIterator for KeyboardEnhancementFlags

type Item = KeyboardEnhancementFlags

type IntoIter = Iter<KeyboardEnhancementFlags>

impl IntoIterator for FileAccess

type Item = FileAccess

type IntoIter = Iter<FileAccess>

impl IntoIterator for Root

type Item = Root

type IntoIter = Iter<Root>

impl IntoIterator for FileChooserType

type Item = FileChooserType

type IntoIter = Iter<FileChooserType>

impl IntoIterator for FileDialogOptions

type Item = FileDialogOptions

type IntoIter = Iter<FileDialogOptions>

impl IntoIterator for LineStyle

type Item = LineStyle

type IntoIter = Iter<LineStyle>

impl IntoIterator for Align

type Item = Align

type IntoIter = Iter<Align>

impl IntoIterator for CallbackTrigger

type Item = CallbackTrigger

type IntoIter = Iter<CallbackTrigger>

impl IntoIterator for Damage

type Item = Damage

type IntoIter = Iter<Damage>

impl IntoIterator for devela::_dep::fltk::enums::Mode

type Item = Mode

type IntoIter = Iter<Mode>

impl IntoIterator for Shortcut

type Item = Shortcut

type IntoIter = Iter<Shortcut>

impl IntoIterator for ColorChooser

type Item = Widget

type IntoIter = IntoIter<<ColorChooser as IntoIterator>::Item>

impl IntoIterator for Flex

type Item = Widget

type IntoIter = IntoIter<<Flex as IntoIterator>::Item>

impl IntoIterator for Grid

type Item = Widget

type IntoIter = IntoIter<<Grid as IntoIterator>::Item>

impl IntoIterator for GridAlign

type Item = GridAlign

type IntoIter = Iter<GridAlign>

impl IntoIterator for Group

type Item = Widget

type IntoIter = IntoIter<<Group as IntoIterator>::Item>

impl IntoIterator for Pack

type Item = Widget

type IntoIter = IntoIter<<Pack as IntoIterator>::Item>

impl IntoIterator for Scroll

type Item = Widget

type IntoIter = IntoIter<<Scroll as IntoIterator>::Item>

impl IntoIterator for Tabs

type Item = Widget

type IntoIter = IntoIter<<Tabs as IntoIterator>::Item>

impl IntoIterator for Tile

type Item = Widget

type IntoIter = IntoIter<<Tile as IntoIterator>::Item>

impl IntoIterator for Wizard

type Item = Widget

type IntoIter = IntoIter<<Wizard as IntoIterator>::Item>

impl IntoIterator for AnimGifImageFlags

type Item = AnimGifImageFlags

Trait IntoIterator