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 60
//! Data parallelism library for async-std.
//!
//! This library provides convenient parallel iteration of
//! [`Streams`](https://docs.rs/futures-core). Analogous to how
//! [Rayon](https://docs.rs/rayon/) provides parallel iteration of
//! `Iterator`s. This allows processing data coming from a stream in parallel,
//! enabling use of *all* system resources.
//!
//! You can read about the design decisions and motivation in the "parallel
//! streams" section of the ["streams
//! concurrency"](https://blog.yoshuawuyts.com/streams-concurrency/#parallel-streams)
//! blog post.
//!
//! # Differences with Rayon
//!
//! Rayon is a data parallelism library built for synchronous Rust, powered by
//! an underlying thread pool. async-std manages a thread pool as well, but the
//! key difference with Rayon is that async-std (and futures) are optimized for
//! *latency*, while Rayon is optimized for *throughput*.
//!
//! As a rule of thumb: if you want to speed up doing heavy calculations you
//! probably want to use Rayon. If you want to parallelize network requests
//! consider using `parallel-stream`.
//!
//! # Examples
//!
//! ```
//! use parallel_stream::prelude::*;
//!
//! #[async_std::main]
//! async fn main() {
//! let v = vec![1, 2, 3, 4];
//! let mut out: Vec<usize> = v
//! .into_par_stream()
//! .map(|n| async move { n * n })
//! .collect()
//! .await;
//! out.sort();
//! assert_eq!(out, vec![1, 4, 9, 16]);
//! }
//! ```
#![forbid(unsafe_code)]
#![deny(missing_debug_implementations, nonstandard_style)]
#![warn(missing_docs)]
mod from_parallel_stream;
mod from_stream;
mod into_parallel_stream;
mod par_stream;
pub use from_parallel_stream::FromParallelStream;
pub use from_stream::{from_stream, FromStream};
pub use into_parallel_stream::IntoParallelStream;
pub use par_stream::{ForEach, Map, NextFuture, ParallelStream, Take};
pub mod prelude;
pub mod vec;
pub(crate) mod utils;