Trait enso_prelude::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]);

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

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

Provided methods

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬 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

impl Extend<OsString> for OsString

pub fn extend<T>(&mut self, iter: T) where
    T: IntoIterator<Item = OsString>, 

impl<P> Extend<P> for PathBuf where
    P: AsRef<Path>, 

pub fn extend<I>(&mut self, iter: I) where
    I: IntoIterator<Item = P>, 

pub fn extend_one(&mut self, p: P)

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

impl<'a> Extend<Cow<'a, OsStr>> for OsString

pub fn extend<T>(&mut self, iter: T) where
    T: IntoIterator<Item = Cow<'a, OsStr>>, 

impl<'a> Extend<&'a OsStr> for OsString

pub fn extend<T>(&mut self, iter: T) where
    T: IntoIterator<Item = &'a OsStr>, 

impl Extend<()> for ()

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

pub fn extend_one(&mut self, _item: ())

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

impl<'a, T> Extend<&'a T> for BTreeSet<T> where
    T: 'a + Ord + Copy, 

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

pub fn extend_one(&mut self, &'a T)

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

impl<'a> Extend<Cow<'a, str>> for String

pub fn extend<I>(&mut self, iter: I) where
    I: IntoIterator<Item = Cow<'a, str>>, 

pub fn extend_one(&mut self, s: Cow<'a, str>)

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

impl<'a, T> Extend<&'a T> for BinaryHeap<T> where
    T: 'a + Ord + Copy, 

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

pub fn extend_one(&mut self, &'a T)

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

pub fn extend_reserve(&mut self, additional: usize)

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

impl<'a, T> Extend<&'a T> for LinkedList<T> where
    T: 'a + Copy, 

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

pub fn extend_one(&mut self, &'a T)

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

impl<'a> Extend<&'a char> for String

pub fn extend<I>(&mut self, iter: I) where
    I: IntoIterator<Item = &'a char>, 

pub fn extend_one(&mut self, &'a char)

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

pub fn extend_reserve(&mut self, additional: usize)

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

impl<A> Extend<A> for VecDeque<A>

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

pub fn extend_one(&mut self, elem: A)

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

pub fn extend_reserve(&mut self, additional: usize)

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

impl<T> Extend<T> for BinaryHeap<T> where
    T: Ord, 

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

pub fn extend_one(&mut self, item: T)

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

pub fn extend_reserve(&mut self, additional: usize)

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

impl<'a, T> Extend<&'a T> for VecDeque<T> where
    T: 'a + Copy, 

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

pub fn extend_one(&mut self, &T)

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

pub fn extend_reserve(&mut self, additional: usize)

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

impl<T> Extend<T> for BTreeSet<T> where
    T: Ord, 

pub fn extend<Iter>(&mut self, iter: Iter) where
    Iter: IntoIterator<Item = T>, 

pub fn extend_one(&mut self, elem: T)

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

impl Extend<String> for String

pub fn extend<I>(&mut self, iter: I) where
    I: IntoIterator<Item = String>, 

pub fn extend_one(&mut self, s: String)

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

impl<T, A> Extend<T> for Vec<T, A> where
    A: Allocator, 

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

pub fn extend_one(&mut self, item: T)

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

pub fn extend_reserve(&mut self, additional: usize)

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

impl<'a> Extend<&'a str> for String

pub fn extend<I>(&mut self, iter: I) where
    I: IntoIterator<Item = &'a str>, 

pub fn extend_one(&mut self, s: &'a str)

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

impl<T> Extend<T> for LinkedList<T>

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

pub fn extend_one(&mut self, elem: T)

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

impl Extend<Box<str, Global>> for String

pub fn extend<I>(&mut self, iter: I) where
    I: IntoIterator<Item = Box<str, Global>>, 

impl<'a, T, A> Extend<&'a T> for Vec<T, A> where
    T: 'a + Copy,
    A: 'a + Allocator, 

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.

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

pub fn extend_one(&mut self, &'a T)

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

pub fn extend_reserve(&mut self, additional: usize)

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

impl Extend<char> for String

pub fn extend<I>(&mut self, iter: I) where
    I: IntoIterator<Item = char>, 

pub fn extend_one(&mut self, c: char)

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

pub fn extend_reserve(&mut self, additional: usize)

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

impl<L, R, A> Extend<A> for Either<L, R> where
    R: Extend<A>,
    L: Extend<A>, 

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

impl<T, S> Extend<<T as WeakElement>::Strong> for PtrWeakHashSet<T, S> where
    T: WeakElement,
    S: BuildHasher,
    <T as WeakElement>::Strong: Deref, 

pub fn extend<I>(&mut self, iter: I) where
    I: IntoIterator<Item = <T as WeakElement>::Strong>, 

impl<T, S> Extend<<T as WeakElement>::Strong> for WeakHashSet<T, S> where
    T: WeakKey,
    S: BuildHasher, 

pub fn extend<I>(&mut self, iter: I) where
    I: IntoIterator<Item = <T as WeakElement>::Strong>, 

impl<K, V, S> Extend<(<K as WeakElement>::Strong, <V as WeakElement>::Strong)> for WeakWeakHashMap<K, V, S> where
    S: BuildHasher,
    K: WeakKey,
    V: WeakElement, 

pub fn extend<T>(&mut self, iter: T) where
    T: IntoIterator<Item = (<K as WeakElement>::Strong, <V as WeakElement>::Strong)>, 

impl<'a, K, V, S> Extend<(&'a <K as WeakElement>::Strong, &'a V)> for PtrWeakKeyHashMap<K, V, S> where
    S: BuildHasher,
    K: 'a + WeakElement,
    V: 'a + Clone,
    <K as WeakElement>::Strong: Clone,
    <K as WeakElement>::Strong: Deref, 

pub fn extend<T>(&mut self, iter: T) where
    T: IntoIterator<Item = (&'a <K as WeakElement>::Strong, &'a V)>, 

impl<K, V, S> Extend<(<K as WeakElement>::Strong, <V as WeakElement>::Strong)> for PtrWeakWeakHashMap<K, V, S> where
    S: BuildHasher,
    K: WeakElement,
    V: WeakElement,
    <K as WeakElement>::Strong: Deref, 

pub fn extend<T>(&mut self, iter: T) where
    T: IntoIterator<Item = (<K as WeakElement>::Strong, <V as WeakElement>::Strong)>, 

impl<K, V, S> Extend<(<K as WeakElement>::Strong, V)> for PtrWeakKeyHashMap<K, V, S> where
    S: BuildHasher,
    K: WeakElement,
    <K as WeakElement>::Strong: Deref, 

pub fn extend<T>(&mut self, iter: T) where
    T: IntoIterator<Item = (<K as WeakElement>::Strong, V)>, 

impl<T, R> Extend<T> for VecStorage<T, R, Dynamic> where
    R: Dim, 

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

Extends the number of columns of the VecStorage with elements from the given iterator.

Panics

This function panics if the number of elements yielded by the given iterator is not a multiple of the number of rows of the VecStorage.

impl<'a, T, R> Extend<&'a T> for VecStorage<T, R, Dynamic> where
    T: 'a + Copy,
    R: Dim, 

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

Extends the number of columns of the VecStorage with elements from the given iterator.

Panics

This function panics if the number of elements yielded by the given iterator is not a multiple of the number of rows of the VecStorage.

impl<T, R, S, RV, SV> Extend<Matrix<T, RV, Const<1_usize>, SV>> for Matrix<T, R, Dynamic, S> where
    T: Scalar,
    R: Dim,
    S: Extend<Matrix<T, RV, Const<1_usize>, SV>>,
    RV: Dim,
    SV: Storage<T, RV, Const<1_usize>>,
    ShapeConstraint: SameNumberOfRows<R, RV>, 

pub fn extend<I>(&mut self, iter: I) where
    I: IntoIterator<Item = Matrix<T, RV, Const<1_usize>, SV>>, 

Extends the number of columns of a Matrix with Vectors from a given iterator.

Example

let data = vec![0, 1, 2,          // column 1
                3, 4, 5];         // column 2

let mut matrix = DMatrix::from_vec(3, 2, data);

matrix.extend(
  vec![Vector3::new(6,  7,  8),   // column 3
       Vector3::new(9, 10, 11)]); // column 4

assert!(matrix.eq(&Matrix3x4::new(0, 3, 6,  9,
                                  1, 4, 7, 10,
                                  2, 5, 8, 11)));

Panics

This function panics if the dimension of each Vector yielded by the given iterator is not equal to the number of rows of this Matrix.

let mut matrix =
  DMatrix::from_vec(3, 2,
                    vec![0, 1, 2,   // column 1
                         3, 4, 5]); // column 2

// The following panics because this matrix can only be extended with 3-dimensional vectors.
matrix.extend(
  vec![Vector2::new(6,  7)]); // too few dimensions!

let mut matrix =
  DMatrix::from_vec(3, 2,
                    vec![0, 1, 2,   // column 1
                         3, 4, 5]); // column 2

// The following panics because this matrix can only be extended with 3-dimensional vectors.
matrix.extend(
  vec![Vector4::new(6, 7, 8, 9)]); // too few dimensions!

impl<T, S> Extend<T> for Matrix<T, Dynamic, Const<1_usize>, S> where
    T: Scalar,
    S: Extend<T>, 

Extend the number of rows of the Vector with elements from a given iterator.

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

Extend the number of rows of a Vector with elements from the given iterator.

Example

let mut vector = DVector::from_vec(vec![0, 1, 2]);
vector.extend(vec![3, 4, 5]);
assert!(vector.eq(&DVector::from_vec(vec![0, 1, 2, 3, 4, 5])));

impl<T, R, RV, SV> Extend<Matrix<T, RV, Const<1_usize>, SV>> for VecStorage<T, R, Dynamic> where
    T: Scalar,
    R: Dim,
    RV: Dim,
    SV: Storage<T, RV, Const<1_usize>>,
    ShapeConstraint: SameNumberOfRows<R, RV>, 

pub fn extend<I>(&mut self, iter: I) where
    I: IntoIterator<Item = Matrix<T, RV, Const<1_usize>, SV>>, 

Extends the number of columns of the VecStorage with vectors from the given iterator.

Panics

This function panics if the number of rows of each Vector yielded by the iterator is not equal to the number of rows of this VecStorage.

impl<T> Extend<T> for VecStorage<T, Dynamic, Const<1_usize>>

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

Extends the number of rows of the VecStorage with elements from the given iterator.

impl<T, R, S> Extend<T> for Matrix<T, R, Dynamic, S> where
    T: Scalar,
    R: Dim,
    S: Extend<T>, 

Extend the number of columns of the Matrix with elements from a given iterator.

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

Extend the number of columns of the Matrix with elements from the given iterator.

Example

let data = vec![0, 1, 2,      // column 1
                3, 4, 5];     // column 2

let mut matrix = DMatrix::from_vec(3, 2, data);

matrix.extend(vec![6, 7, 8]); // column 3

assert!(matrix.eq(&Matrix3::new(0, 3, 6,
                                1, 4, 7,
                                2, 5, 8)));

Panics

This function panics if the number of elements yielded by the given iterator is not a multiple of the number of rows of the Matrix.

let data = vec![0, 1, 2,  // column 1
                3, 4, 5]; // column 2

let mut matrix = DMatrix::from_vec(3, 2, data);

// The following panics because the vec length is not a multiple of 3.
matrix.extend(vec![6, 7, 8, 9]);

Implementors

impl<'a, K, V> Extend<(&'a K, &'a V)> for BTreeMap<K, V> where
    K: Ord + Copy,
    V: Copy, 

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

pub fn extend_one(&mut self, (&'a K, &'a V))

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

impl<'a, K, V, S> Extend<(&'a <K as WeakElement>::Strong, &'a V)> for WeakKeyHashMap<K, V, S> where
    S: BuildHasher,
    K: 'a + WeakKey,
    V: 'a + Clone,
    <K as WeakElement>::Strong: Clone, 

pub fn extend<T>(&mut self, iter: T) where
    T: IntoIterator<Item = (&'a <K as WeakElement>::Strong, &'a V)>, 

impl<'a, K, V, S> Extend<(&'a K, &'a <V as WeakElement>::Strong)> for WeakValueHashMap<K, V, S> where
    S: BuildHasher,
    K: 'a + Eq + Hash + Clone,
    V: 'a + WeakElement,
    <V as WeakElement>::Strong: Clone, 

pub fn extend<T>(&mut self, iter: T) where
    T: IntoIterator<Item = (&'a K, &'a <V as WeakElement>::Strong)>, 

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

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

pub fn extend_one(&mut self, (&'a K, &'a V))

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

pub fn extend_reserve(&mut self, additional: usize)

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

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

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

pub fn extend_one(&mut self, &'a T)

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

pub fn extend_reserve(&mut self, additional: usize)

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

impl<A> Extend<<A as Array>::Item> for SmallVec<A> where
    A: Array, 

pub fn extend<I>(&mut self, iterable: I) where
    I: IntoIterator<Item = <A as Array>::Item>, 

impl<K, V> Extend<(K, V)> for BTreeMap<K, V> where
    K: Ord, 

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

pub fn extend_one(&mut self, (K, V))

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

impl<K, V, S> Extend<(<K as WeakElement>::Strong, V)> for WeakKeyHashMap<K, V, S> where
    S: BuildHasher,
    K: WeakKey, 

pub fn extend<T>(&mut self, iter: T) where
    T: IntoIterator<Item = (<K as WeakElement>::Strong, V)>, 

impl<K, V, S> Extend<(K, <V as WeakElement>::Strong)> for WeakValueHashMap<K, V, S> where
    S: BuildHasher,
    K: Eq + Hash,
    V: WeakElement, 

pub fn extend<T>(&mut self, iter: T) where
    T: IntoIterator<Item = (K, <V as WeakElement>::Strong)>, 

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

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

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

pub fn extend_one(&mut self, (K, V))

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

pub fn extend_reserve(&mut self, additional: usize)

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

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

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

pub fn extend_one(&mut self, item: T)

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

pub fn extend_reserve(&mut self, additional: usize)

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