collect-all 0.1.0

vec! for everything: easily make literals of any collection!
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

# collect-all

[![Build status](https://github.com/dzfrias/collect-all/actions/workflows/ci.yml/badge.svg)](https://github.com/dzfrias/collect-all/actions)
[![Crates.io](https://img.shields.io/crates/v/collect-all.svg)](https://crates.io/crates/collect-all)
[![Docs Status](https://docs.rs/collect-all/badge.svg)](https://docs.rs/collect-all)

A macro to create collection literals for any type! Think of
[`vec!`](https://doc.rust-lang.org/std/macro.vec.html), but for any collection
type!

Internally, this just uses the
[`Iterator::collect()`](https://doc.rust-lang.org/std/iter/trait.Iterator.html#method.collect)
method. Since `collect` is powered by
[`FromIterator`](https://doc.rust-lang.org/std/iter/trait.FromIterator.html),
implement it to use this macro for your own types!

## Examples

Basic use, inferring the type of the collection

```rust
use collect_all::collect;
use std::collections::HashSet;

let hashset: HashSet<i32> = collect![1, 2, 3];
assert_eq!(HashSet::from_iter([1, 2, 3]), hashset);
```

Specifying the type in the macro invocation

```rust
use collect_all::collect;
use std::collections::HashMap;

let hashmap = collect![HashMap<&str, u8>: ("one", 1), ("two", 2)];
assert_eq!(HashMap::from_iter([("one", 1), ("two", 2)]), hashmap);
```

Creating with a given capacity

```rust
use collect_all::collect;
use std::path::PathBuf;

let pathbuf = collect![PathBuf: "path", "to", "file"; 10];
assert_eq!(PathBuf::from("path/to/file"), pathbuf);
assert!(pathbuf.capacity() >= 10);
```

Note that this relies on a few things that are **not** strictly guaranteed for a given
collection:

1. `with_capacity` is a method of the target type (for example, see [`Vec::with_capacity`](https://doc.rust-lang.org/alloc/vec/struct.Vec.html#method.with_capacity))
2. The target type implements [`Extend`](https://doc.rust-lang.org/std/iter/trait.Extend.html)

## License

This crate is licensed under the
[MIT](https://github.com/dzfrias/collect-all/LICENSE) license.