std::iter::Extend - Rust
Description: API documentation for the Rust `Extend` trait in crate `std`.
Keywords: rust, rustlang, rust-lang, Extend

# 1.0.0[−][src]Trait std::iter::Extend

    pub trait Extend<A> {
        fn extend<T>(&mut self, iter: T)
        where
            T: IntoIterator<Item = A>;

        fn extend_one(&mut self, item: A) { ... }
        fn extend_reserve(&mut self, additional: usize) { ... }
    }

Extend a collection with the contents of an iterator.

Iterators produce a series of values, and collections can also be thought of as a series of values. The `Extend` trait bridges this gap, allowing you to extend a collection by including the contents of that iterator. When extending a collection with an already existing key, that entry is updated or, in the case of collections that permit multiple entries with equal keys, that entry is inserted.

# Examples

Basic usage:

    // You can extend a String with some chars:
    let mut message = String::from("The first three letters are: ");

    message.extend(&['a', 'b', 'c']);

    assert_eq!("abc", &message[29..32]);

Run

Implementing `Extend`:

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

    // since MyCollection has a list of i32s, we implement Extend for i32
    impl Extend<i32> for MyCollection {

        // This is a bit simpler with the concrete type signature: we can call
        // extend on anything which can be turned into an Iterator which gives
        // us i32s. Because we need i32s to put into MyCollection.
        fn extend<T: IntoIterator<Item=i32>>(&mut self, iter: T) {

            // The implementation is very straightforward: loop through the
            // iterator, and add() each element to ourselves.
            for elem in iter {
                self.add(elem);
            }
        }
    }

    let mut c = MyCollection::new();

    c.add(5);
    c.add(6);
    c.add(7);

    // let's extend our collection with three more numbers
    c.extend(vec![1, 2, 3]);

    // we've added these elements onto the end
    assert_eq!("MyCollection([5, 6, 7, 1, 2, 3])", format!("{:?}", c));

Run

## Required methods

### `fn extend<T>(&mut self, iter: T) where
T: IntoIterator<Item = A>,`

Extends a collection with the contents of an iterator.

As this is the only required method for this trait, the trait-level docs contain more details.

# Examples

Basic usage:

    // You can extend a String with some chars:
    let mut message = String::from("abc");

    message.extend(['d', 'e', 'f'].iter());

    assert_eq!("abcdef", &message);

Run
Loading content...

## Provided methods

### `fn extend_one(&mut self, item: A)`

🔬 This is a nightly-only experimental API. (`extend_one` #72631)

Extends a collection with exactly one element.

### `fn extend_reserve(&mut self, additional: usize)`

🔬 This is a nightly-only experimental API. (`extend_one` #72631)

Reserves capacity in a collection for the given number of additional elements.

The default implementation does nothing.

Loading content...

## Implementations on Foreign Types

### `impl<'a, T, S> Extend<&'a T> for HashSet<T, S> where
S: BuildHasher,
T: 'a + Eq + Hash + Copy,`

#### `fn extend<I>(&mut self, iter: I) where
I: IntoIterator<Item = &'a T>,`

### `impl<'a, K, V, S> Extend<(&'a K, &'a V)> for HashMap<K, V, S> where
K: Eq + Hash + Copy,
S: BuildHasher,
V: Copy,`

#### `fn extend<T>(&mut self, iter: T) where
T: IntoIterator<Item = (&'a K, &'a V)>,`

### `impl<K, V, S> Extend<(K, V)> for HashMap<K, V, S> where
K: Eq + Hash,
S: BuildHasher,`

#### `fn extend<T>(&mut self, iter: T) where
T: IntoIterator<Item = (K, V)>,`

### `impl<T, S> Extend<T> for HashSet<T, S> where
S: BuildHasher,
T: Eq + Hash,`

#### `fn extend<I>(&mut self, iter: I) where
I: IntoIterator<Item = T>,`

Loading content...

## Implementors

### `impl Extend<char> for String`[src]

#### `fn extend<I>(&mut self, iter: I) where
I: IntoIterator<Item = char>,` [src]

#### `fn extend_one(&mut self, c: char)`[src]

🔬 This is a nightly-only experimental API. (`extend_one` #72631)

#### `fn extend_reserve(&mut self, additional: usize)`[src]

🔬 This is a nightly-only experimental API. (`extend_one` #72631)

### `impl Extend<()> for ()`[src]

#### `fn extend<T>(&mut self, iter: T) where
T: IntoIterator<Item = ()>,` [src]

#### `fn extend_one(&mut self, _item: ())`[src]

🔬 This is a nightly-only experimental API. (`extend_one` #72631)

### `impl Extend<Box<str>> for String`[src]

#### `fn extend<I>(&mut self, iter: I) where
I: IntoIterator<Item = Box<str>>,` [src]

### `impl Extend<String> for String`[src]

#### `fn extend<I>(&mut self, iter: I) where
I: IntoIterator<Item = String>,` [src]

#### `fn extend_one(&mut self, s: String)`[src]

🔬 This is a nightly-only experimental API. (`extend_one` #72631)

### `impl<'a> Extend<&'a char> for String`[src]

#### `fn extend<I>(&mut self, iter: I) where
I: IntoIterator<Item = &'a char>,` [src]

#### `fn extend_one(&mut self, &'a char)`[src]

🔬 This is a nightly-only experimental API. (`extend_one` #72631)

#### `fn extend_reserve(&mut self, additional: usize)`[src]

🔬 This is a nightly-only experimental API. (`extend_one` #72631)

### `impl<'a> Extend<&'a str> for String`[src]

#### `fn extend<I>(&mut self, iter: I) where
I: IntoIterator<Item = &'a str>,` [src]

#### `fn extend_one(&mut self, s: &'a str)`[src]

🔬 This is a nightly-only experimental API. (`extend_one` #72631)

### `impl<'a> Extend<Cow<'a, str>> for String`[src]

#### `fn extend<I>(&mut self, iter: I) where
I: IntoIterator<Item = Cow<'a, str>>,` [src]

#### `fn extend_one(&mut self, s: Cow<'a, str>)`[src]

🔬 This is a nightly-only experimental API. (`extend_one` #72631)

### `impl<'a, K, V> Extend<(&'a K, &'a V)> for BTreeMap<K, V> where
K: Ord + Copy,
V: Copy,` [src]

#### `fn extend<I>(&mut self, iter: I) where
I: IntoIterator<Item = (&'a K, &'a V)>,` [src]

#### `fn extend_one(&mut self, (&'a K, &'a V))`[src]

🔬 This is a nightly-only experimental API. (`extend_one` #72631)

### `impl<'a, K, V, S> Extend<(&'a K, &'a V)> for std::collections::HashMap<K, V, S> where
K: Eq + Hash + Copy,
V: Copy,
S: BuildHasher,` [src]

#### `fn extend<T: IntoIterator<Item = (&'a K, &'a V)>>(&mut self, iter: T)`[src]

#### `fn extend_one(&mut self, (k, v): (&'a K, &'a V))`[src]

🔬 This is a nightly-only experimental API. (`extend_one` #72631)

#### `fn extend_reserve(&mut self, additional: usize)`[src]

🔬 This is a nightly-only experimental API. (`extend_one` #72631)

### `impl<'a, T> Extend<&'a T> for BTreeSet<T> where
T: 'a + Ord + Copy,` [src]

#### `fn extend<I>(&mut self, iter: I) where
I: IntoIterator<Item = &'a T>,` [src]

#### `fn extend_one(&mut self, &'a T)`[src]

🔬 This is a nightly-only experimental API. (`extend_one` #72631)

### `impl<'a, T> Extend<&'a T> for BinaryHeap<T> where
T: 'a + Ord + Copy,` [src]

#### `fn extend<I>(&mut self, iter: I) where
I: IntoIterator<Item = &'a T>,` [src]

#### `fn extend_one(&mut self, &'a T)`[src]

🔬 This is a nightly-only experimental API. (`extend_one` #72631)

#### `fn extend_reserve(&mut self, additional: usize)`[src]

🔬 This is a nightly-only experimental API. (`extend_one` #72631)

### `impl<'a, T> Extend<&'a T> for LinkedList<T> where
T: 'a + Copy,` [src]

#### `fn extend<I>(&mut self, iter: I) where
I: IntoIterator<Item = &'a T>,` [src]

#### `fn extend_one(&mut self, &'a T)`[src]

🔬 This is a nightly-only experimental API. (`extend_one` #72631)

### `impl<'a, T> Extend<&'a T> for VecDeque<T> where
T: 'a + Copy,` [src]

#### `fn extend<I>(&mut self, iter: I) where
I: IntoIterator<Item = &'a T>,` [src]

#### `fn extend_one(&mut self, &T)`[src]

🔬 This is a nightly-only experimental API. (`extend_one` #72631)

#### `fn extend_reserve(&mut self, additional: usize)`[src]

🔬 This is a nightly-only experimental API. (`extend_one` #72631)

### `impl<'a, T> Extend<&'a T> for Vec<T> where
T: 'a + Copy,` [src]

Extend implementation that copies elements out of references before pushing them onto the Vec.

This implementation is specialized for slice iterators, where it uses `copy_from_slice` to append the entire slice at once.

#### `fn extend<I>(&mut self, iter: I) where
I: IntoIterator<Item = &'a T>,` [src]

#### `fn extend_one(&mut self, &'a T)`[src]

🔬 This is a nightly-only experimental API. (`extend_one` #72631)

#### `fn extend_reserve(&mut self, additional: usize)`[src]

🔬 This is a nightly-only experimental API. (`extend_one` #72631)

### `impl<'a, T, S> Extend<&'a T> for std::collections::HashSet<T, S> where
T: 'a + Eq + Hash + Copy,
S: BuildHasher,` [src]

#### `fn extend<I: IntoIterator<Item = &'a T>>(&mut self, iter: I)`[src]

#### `fn extend_one(&mut self, item: &'a T)`[src]

🔬 This is a nightly-only experimental API. (`extend_one` #72631)

#### `fn extend_reserve(&mut self, additional: usize)`[src]

🔬 This is a nightly-only experimental API. (`extend_one` #72631)

### `impl<A> Extend<A> for VecDeque<A>`[src]

#### `fn extend<T>(&mut self, iter: T) where
T: IntoIterator<Item = A>,` [src]

#### `fn extend_one(&mut self, elem: A)`[src]

🔬 This is a nightly-only experimental API. (`extend_one` #72631)

#### `fn extend_reserve(&mut self, additional: usize)`[src]

🔬 This is a nightly-only experimental API. (`extend_one` #72631)

### `impl<K, V> Extend<(K, V)> for BTreeMap<K, V> where
K: Ord,` [src]

#### `fn extend<T>(&mut self, iter: T) where
T: IntoIterator<Item = (K, V)>,` [src]

#### `fn extend_one(&mut self, (K, V))`[src]

🔬 This is a nightly-only experimental API. (`extend_one` #72631)

### `impl<K, V, S> Extend<(K, V)> for std::collections::HashMap<K, V, S> where
K: Eq + Hash,
S: BuildHasher,` [src]

Inserts all new key-values from the iterator and replaces values with existing keys with new values returned from the iterator.

#### `fn extend<T: IntoIterator<Item = (K, V)>>(&mut self, iter: T)`[src]

#### `fn extend_one(&mut self, (k, v): (K, V))`[src]

🔬 This is a nightly-only experimental API. (`extend_one` #72631)

#### `fn extend_reserve(&mut self, additional: usize)`[src]

🔬 This is a nightly-only experimental API. (`extend_one` #72631)

### `impl<P: AsRef<Path>> Extend<P> for PathBuf`[src]

#### `fn extend<I: IntoIterator<Item = P>>(&mut self, iter: I)`[src]

#### `fn extend_one(&mut self, p: P)`[src]

🔬 This is a nightly-only experimental API. (`extend_one` #72631)

### `impl<T> Extend<T> for BTreeSet<T> where
T: Ord,` [src]

#### `fn extend<Iter>(&mut self, iter: Iter) where
Iter: IntoIterator<Item = T>,` [src]

#### `fn extend_one(&mut self, elem: T)`[src]

🔬 This is a nightly-only experimental API. (`extend_one` #72631)

### `impl<T> Extend<T> for BinaryHeap<T> where
T: Ord,` [src]

#### `fn extend<I>(&mut self, iter: I) where
I: IntoIterator<Item = T>,` [src]

#### `fn extend_one(&mut self, item: T)`[src]

🔬 This is a nightly-only experimental API. (`extend_one` #72631)

#### `fn extend_reserve(&mut self, additional: usize)`[src]

🔬 This is a nightly-only experimental API. (`extend_one` #72631)

### `impl<T> Extend<T> for LinkedList<T>`[src]

#### `fn extend<I>(&mut self, iter: I) where
I: IntoIterator<Item = T>,` [src]

#### `fn extend_one(&mut self, elem: T)`[src]

🔬 This is a nightly-only experimental API. (`extend_one` #72631)

### `impl<T> Extend<T> for Vec<T>`[src]

#### `fn extend<I>(&mut self, iter: I) where
I: IntoIterator<Item = T>,` [src]

#### `fn extend_one(&mut self, item: T)`[src]

🔬 This is a nightly-only experimental API. (`extend_one` #72631)

#### `fn extend_reserve(&mut self, additional: usize)`[src]

🔬 This is a nightly-only experimental API. (`extend_one` #72631)

### `impl<T, S> Extend<T> for std::collections::HashSet<T, S> where
T: Eq + Hash,
S: BuildHasher,` [src]

#### `fn extend<I: IntoIterator<Item = T>>(&mut self, iter: I)`[src]

#### `fn extend_one(&mut self, item: T)`[src]

🔬 This is a nightly-only experimental API. (`extend_one` #72631)

#### `fn extend_reserve(&mut self, additional: usize)`[src]

🔬 This is a nightly-only experimental API. (`extend_one` #72631)
Loading content...