Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Martin Ockajak committed Jul 29, 2024
1 parent 6b6a6df commit 3cd23a9
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 18 deletions.
21 changes: 12 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,24 @@ Practical extension methods for Rust standard library collections.
Enables direct functional-style collection manipulation without the usual iterator boilerplate.


## Features
## Overview

- Equivalents of standard iterator methods are added to standard library collections
- Additional utility methods commonly found in collection libraries are also included
- Transformation methods return a new collection instance instead of returning an iterator
- Methods which modify a collection return a new collection instance instead of an iterator
- All methods treat collection instances as immutable although some may consume them
- Performance is near optimal and overhead is limited to new collection creation


## Functionality

- [Searching](#searching) - [Modifying](#modifying) - [Filtering](#filtering) -
[Mapping](#mapping) - [Inspecting](#inspecting) - [Aggregating](#aggregating)

- [Selecting](#selecting) - [Converting](#converting) - [Partitioning](#partitioning) -
[Merging](#merging) - [Sorting](#sorting) - [Miscellaneous](#miscellaneous)


## Examples

```rust
Expand Down Expand Up @@ -45,13 +55,6 @@ a.rev().into_iter().into_deque(); // VecDeque::from([3, 2, 1])

## Methods

[Searching](#searching) - [Modifying](#modifying) - [Filtering](#filtering) -
[Mapping](#mapping) - [Inspecting](#inspecting) - [Aggregating](#aggregating)

[Selecting](#selecting) - [Converting](#converting) - [Partitioning](#partitioning) -
[Merging](#merging) - [Sorting](#sorting) - [Miscellaneous](#miscellaneous)


### Searching

| Method / Collection type | Vec, VecDeque, LinkedList | Slice | HashSet, BTreeSet, BinaryHeap | HashMap, BTreeMap | Consuming |
Expand Down
21 changes: 12 additions & 9 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,24 @@
//! Enables direct functional-style collection manipulation without the usual iterator boilerplate.
//!
//!
//! ## Features
//! ## Overview
//!
//! - Equivalents of standard iterator methods are added to standard library collections
//! - Additional utility methods commonly found in collection libraries are also included
//! - Transformation methods return a new collection instance instead of returning an iterator
//! - Methods which modify a collection return a new collection instance instead of an iterator
//! - All methods treat collection instances as immutable although some may consume them
//! - Performance is near optimal and overhead is limited to new collection creation
//!
//!
//! ## Functionality
//!
//! - [Searching](#searching) - [Modifying](#modifying) - [Filtering](#filtering) -
//! [Mapping](#mapping) - [Inspecting](#inspecting) - [Aggregating](#aggregating)

Check failure on line 20 in src/lib.rs

View workflow job for this annotation

GitHub Actions / Build

doc list item missing indentation
//!
//! - [Selecting](#selecting) - [Converting](#converting) - [Partitioning](#partitioning) -
//! [Merging](#merging) - [Sorting](#sorting) - [Miscellaneous](#miscellaneous)

Check failure on line 23 in src/lib.rs

View workflow job for this annotation

GitHub Actions / Build

doc list item missing indentation
//!
//!
//! ## Examples
//!
//! ```rust
Expand Down Expand Up @@ -51,13 +61,6 @@
//!
//! ## Methods
//!
//! [Searching](#searching) - [Modifying](#modifying) - [Filtering](#filtering) -
//! [Mapping](#mapping) - [Inspecting](#inspecting) - [Aggregating](#aggregating)
//!
//! [Selecting](#selecting) - [Converting](#converting) - [Partitioning](#partitioning) -
//! [Merging](#merging) - [Sorting](#sorting) - [Miscellaneous](#miscellaneous)
//!
//!
//! ### Searching
//!
//! | Method / Collection type | Vec, VecDeque, LinkedList | Slice | HashSet, BTreeSet, BinaryHeap | HashMap, BTreeMap | Consuming |
Expand Down

0 comments on commit 3cd23a9

Please sign in to comment.