Skip to content

Commit

Permalink
Merge pull request #14 from mre/rename-to-futures-batch
Browse files Browse the repository at this point in the history
Rename project to futures-batch (fixes #13)
  • Loading branch information
mre committed Dec 6, 2019
2 parents 5030a9a + 7db1957 commit 0c180a8
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 7 deletions.
6 changes: 3 additions & 3 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
[package]
authors = ["Matthias Endler <matthias-endler@gmx.net>"]
description = "An adaptor that chunks up elements and flushes them after a timeout or when the buffer is full."
description = "An adaptor that chunks up elements and flushes them after a timeout or when the buffer is full. (Formerly known as tokio-batch.)"
license = "MIT OR Apache-2.0"
name = "tokio-batch"
name = "futures-batch"
version = "0.5.0"
edition = "2018"
repository = "https://github.com/mre/tokio-batch"
repository = "https://github.com/mre/futures-batch"

[dependencies]
futures-preview = { version = "0.3.0-alpha.19", features = ["compat"] }
Expand Down
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# tokio-batch
# futures-batch

![Build status](https://github.com/mre/tokio-batch/workflows/Rust/badge.svg)
![Build status](https://github.com/mre/futures-batch/workflows/Rust/badge.svg)

An adaptor that chunks up elements and flushes them after a timeout or when the buffer is full.
(The project was initially called `tokio-batch`, but was renamed as it has no dependency on Tokio anymore.)

## Description

Expand All @@ -20,7 +21,7 @@ use futures::future;
use futures::stream;
use futures::{FutureExt, StreamExt, TryFutureExt};
use std::time::Duration;
use tokio_batch::ChunksTimeoutStreamExt;
use futures_batch::ChunksTimeoutStreamExt;

fn main() {
let iter = vec![0, 1, 2, 3, 4, 5, 6, 7, 8, 9].into_iter();
Expand All @@ -45,7 +46,7 @@ Check [this blog post](https://rust-lang-nursery.github.io/futures-rs/blog/2019/

## Performance

`tokio-batch` imposes very low overhead on your application. For example, it [is even used to batch syscalls](https://github.com/mre/tokio-batch/issues/4).
`futures-batch` imposes very low overhead on your application. For example, it [is even used to batch syscalls](https://github.com/mre/futures-batch/issues/4).
Under the hood, we are using [`futures-timer`](https://github.com/async-rs/futures-timer), which allows for microsecond timer resolution.
If you find a use-case which is not covered, don't be reluctant to open an issue.

Expand Down

0 comments on commit 0c180a8

Please sign in to comment.