Skip to content

Commit fdf68fa

Browse files
committed
regenerate readme
1 parent 2a5010c commit fdf68fa

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE-MIT)
99

1010
`future_queue` provides ways to run several futures:
11+
1112
* concurrently
1213
* in the order they're spawned
1314
* with global limits
@@ -98,6 +99,11 @@ except it is possible to specify an optional *group* for each future. Each group
9899
weight, and a future will only be scheduled if both the maximum weight and the group weight
99100
aren't exceeded.
100101

102+
The adaptor is as fair as possible under the given constraints: it will schedule futures in
103+
the order they're returned by the stream, without doing any reordering based on weight. When
104+
a future from a group completes, queued up futures in this group will be preferentially
105+
scheduled before any other futures from the provided stream.
106+
101107
The current weight for groups may exceed the maximum weight, similar to `future_queue`.
102108

103109
#### Examples

0 commit comments

Comments
 (0)