cantrip

A Swiss Army Knife for Rust standard library collection types.

Enables direct functional-style collection manipulation without the usual iterator boilerplate and provides many additional operations.

• Enjoy cleaner code with less .into_iter(), .collect() and .clone().

• Leverage non-consuming operations and many convenient utility methods.

• No learning required, use code completion to quickly find a method you need.

Overview

• Existing standard library collections are extended with equivalents of iterator methods

• Additional utility methods commonly found in collection libraries are also included

• Methods which modify a collection return a new collection instead of an iterator

• All methods treat collection instances as immutable, although some consume them

• Standard library method naming conventions are followed as closely as possible

• Performance is near optimal with overhead limited to new collection creation

Functionality

• Searching - Modifying - Filtering - Mapping - Inspecting - Aggregating

• Selecting - Converting - Partitioning - Merging - Sorting - Miscellaneous

Examples

use cantrip::*;

let a = vec![1, 2, 3];

a.fold(0, |r, x| r + x);                 // 6

a.map_ref(|&x| (x, x)).to_map();         // HashMap::from([(1, 1), (2, 2), (3, 3)])

a.flat_map(|x| [x, -x]).sorted();        // vec![-3, -2, -1, 1, 2, 3]

a.filter(|&x| x > 1).to_set();           // HashSet::from([2, 3])

a.group_by(|x| x % 2);                   // HashMap::from([(0, vec![2]), (1, vec![1, 3])])

a.delete(&1).add(2).unique();            // vec![2, 3]

a.substitute_at(0, 4).to_list();         // LinkedList::from([4, 2, 3])

a.position_multi(|&x| x % 2 == 1);       // vec![0, 2]

a.rev().into_iter().to_deque();          // VecDeque::from([3, 2, 1])

Methods

Searching

Modifying

Filtering

Mapping

Inspecting

Aggregating

Selecting

Partitioning

Merging

Sorting

Converting

Miscellaneous

Inspired by

• Rust Collections

• Scala Collections

• Haskell Collections

• Python Collections

• Qt Collections

• Itertools

• More Itertools

Build

Requirements

• Rust 1.85+

Test

cargo test

Benchmark

cargo bench

Contributing

Please feel free to open an issue or a pull request with questions, ideas, features, improvements or fixes.

License

Licensed under either of

• Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.