Trait otter_api_tests::iter::Extend1.0.0[−][src]

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) { ... }
}
Expand description

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]);

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

Required methods

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

Provided methods

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

Extends a collection with exactly one element.

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

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

The default implementation does nothing.

Implementations on Foreign Types

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

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.

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

Extend a HeaderMap with the contents of another HeaderMap.

This function expects the yielded items to follow the same structure as IntoIter.

Panics

This panics if the first yielded item does not have a HeaderName.

Examples

let mut map = HeaderMap::new();

map.insert(ACCEPT, "text/plain".parse().unwrap());
map.insert(HOST, "hello.world".parse().unwrap());

let mut extra = HeaderMap::new();

extra.insert(HOST, "foo.bar".parse().unwrap());
extra.insert(COOKIE, "hello".parse().unwrap());
extra.append(COOKIE, "world".parse().unwrap());

map.extend(extra);

assert_eq!(map["host"], "foo.bar");
assert_eq!(map["accept"], "text/plain");
assert_eq!(map["cookie"], "hello");

let v = map.get_all("host");
assert_eq!(1, v.iter().count());

let v = map.get_all("cookie");
assert_eq!(2, v.iter().count());

Extend the map with all key-value pairs in the iterable.

This is equivalent to calling insert for each of them in order, which means that for keys that already existed in the map, their value is updated but it keeps the existing order.

New keys are inserted in the order they appear in the sequence. If equivalents of a key occur more than once, the last corresponding value prevails.

Extend the map with all key-value pairs in the iterable.

See the first extend method for more details.

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

Implementors

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

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

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

Extend the ArrayVec with an iterator.

Panics if extending the vector exceeds its capacity.

Extend the ArrayVec with an iterator.

Panics if extending the vector exceeds its capacity.