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

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

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

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

## Implementors

- `impl<'a, T> Extend<&'a T> for VecDeque<T> where
  T: 'a + Copy,`
- `impl<T> Extend<T> for LinkedList<T>`
- `impl<'a, K, V> Extend<(&'a K, &'a V)> for BTreeMap<K, V> where
  K: Copy + Ord,
  V: Copy,`
- `impl<A> Extend<A> for VecDeque<A>`
- `impl<'a, T> Extend<&'a T> for LinkedList<T> where
  T: 'a + Copy,`
- `impl<'a, T> Extend<&'a T> for Vec<T> where
  T: 'a + Copy,`
- `impl<'a> Extend<&'a char> for String`
- `impl<'a> Extend<&'a str> for String`
- `impl Extend<String> for String`
- `impl<K, V> Extend<(K, V)> for BTreeMap<K, V> where
  K: Ord,`
- `impl<'a, T> Extend<&'a T> for BinaryHeap<T> where
  T: 'a + Copy + Ord,`
- `impl<'a> Extend<Cow<'a, str>> for String`
- `impl<T> Extend<T> for BinaryHeap<T> where
  T: Ord,`
- `impl<T> Extend<T> for Vec<T>`
- `impl<'a, T> Extend<&'a T> for BTreeSet<T> where
  T: 'a + Copy + Ord,`
- `impl Extend<char> for String`
- `impl<T> Extend<T> for BTreeSet<T> where
  T: Ord,`
- `impl<K, V, S> Extend<(K, V)> for HashMap<K, V, S> where
  K: Eq + Hash,
  S: BuildHasher,`
- `impl<'a, K, V, S> Extend<(&'a K, &'a V)> for HashMap<K, V, S> where
  K: Eq + Hash + Copy,
  V: Copy,
  S: BuildHasher,`
- `impl<T, S> Extend<T> for HashSet<T, S> where
  T: Eq + Hash,
  S: BuildHasher,`
- `impl<'a, T, S> Extend<&'a T> for HashSet<T, S> where
  T: 'a + Eq + Hash + Copy,
  S: BuildHasher,`
- `impl<P: AsRef<Path>> Extend<P> for PathBuf`

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)