Compare commits

..

641 Commits

Author SHA1 Message Date
Yoshua Wuyts 8aa5921dfa
Merge pull request #833 from OSSystems/topic/fix_channel_doc
channel doc: Fix misleading reference to None return on Receiver
5 years ago
Jonathas-Conceicao cd7fb9dec2 channel doc: Fix misleading reference to None return on Receiver
Signed-off-by: Jonathas-Conceicao <jonathas.conceicao@ossystems.com.br>
5 years ago
Yoshua Wuyts c82b1efb69
fix(stream): add send guards on collect
Closes #639 

Co-authored-by: dignifiedquire <me@dignifiedquire.com>
5 years ago
Friedel Ziegelmayer 8c4b425136
Merge pull request #826 from thibault-martinez/kv-log-macro-1.0.6
Update kv-log-macro to 1.0.6
5 years ago
Thibault Martinez 2ab08ebbbc Update kv-log-macro to 1.0.6 5 years ago
Friedel Ziegelmayer 0e7650a421
Merge pull request #822 from async-rs/async-extern-1 5 years ago
dignifiedquire 8f17e9275b test: try to stabilize CI 5 years ago
dignifiedquire 18dffe8b43 refactor: switch to async-mutex for Mutex implementation 5 years ago
Friedel Ziegelmayer 43de93312c
Merge pull request #825 from nbdd0121/master
Fix unused_mut warning in nightly
5 years ago
Gary Guo 2e7e804736 Fix unused_mut warning in nightly 5 years ago
Friedel Ziegelmayer 17ab958ac2
Merge pull request #820 from zhaxzhax/docs-#815 5 years ago
Friedel Ziegelmayer caa76af745
Merge pull request #821 from async-rs/1-6-2
chore: release v1.6.2
5 years ago
dignifiedquire e495ba46b3 chore: release v1.6.2 5 years ago
Afirez 0c2ce52ac4 fix doc missing in #815 5 years ago
Friedel Ziegelmayer 5f418f07ac
Merge pull request #819 from async-rs/fix-sockets 5 years ago
dignifiedquire 06a2fb8c4f fix export 5 years ago
dignifiedquire 1c1c168e1b fix(timer): ensure the runtime is working for timers 5 years ago
Friedel Ziegelmayer 5d55fa7a47
Merge pull request #701 from olegnn/flat_map_fixed 5 years ago
dignifiedquire 093d640ad7 fix(net): ensure the reactor and runtime are running
If this is not done, then reactor is not running, resulting in the sockets not actually connecting.

Closes #818
5 years ago
Oleg Nosov 42425f6c1a
Another hotfix 5 years ago
Yoshua Wuyts a602a91d83
Merge pull request #816 from zhaxzhax/add-udpscket-peeraddr
Add UdpSocket::PeerAddr #307
5 years ago
Afirez 9fa3ce3fd6 Add UdpSocket::PeerAddr #307 5 years ago
Oleg Nosov df22d87d09
Removed unnecessary links + hotfix 5 years ago
Oleg Nosov 924e5a3f41
Merge remote-tracking branch 'origin/master' into flat_map_fixed 5 years ago
Oleg Nosov 2323ac9a8e
Apply suggestions from code review
Co-authored-by: nasa <htilcs1115@gmail.com>
5 years ago
Friedel Ziegelmayer 5c2a3de9e7
Merge pull request #814 from async-rs/1-6-1
chore: release v1.6.1
5 years ago
dignifiedquire e9c6ea873c chore: release v1.6.1 5 years ago
Friedel Ziegelmayer 0d98aac8f7
Merge pull request #812 from thibault-martinez/gh-actions-cache-v2 5 years ago
Thibault Martinez 4555f193a5 ci: update actions/cache to v2 5 years ago
Yoshua Wuyts 61fc2bae72
Merge pull request #809 from async-rs/fix/recursive-block-2
fix(rt): use task::block_on on spawned threads
5 years ago
dignifiedquire 5a1a681d68 fix(rt): use task::block_on on spawned threads
This makes sure to capture threads into the recursive block_on detection.
5 years ago
Friedel Ziegelmayer e12cf80ab0
fix: allow for recursive block-on calls
Fixes #798,#795,#760
5 years ago
Friedel Ziegelmayer 631105b650
Merge pull request #806 from async-rs/fix-feature-unstable 5 years ago
Friedel Ziegelmayer 0897b9184a
Merge pull request #804 from async-rs/tokio02-feature 5 years ago
Friedel Ziegelmayer 6ca7b0977c
Merge pull request #807 from xfix/remove-stdio-lock-methods
Remove stdio lock methods
5 years ago
Konrad Borowski 721760a7a6 Remove stdio lock methods
Fixes #805.
5 years ago
dignifiedquire 8389041414 fix 5 years ago
dignifiedquire 8943ba82dd fix nostd 5 years ago
dignifiedquire 52c72426c1 fix: do not require the runtime to use unstable features 5 years ago
Yoshua Wuyts 0df3c02b81 check tokio02 features 5 years ago
Yoshua Wuyts 166c469d1c Add the tokio02 feature flag 5 years ago
Friedel Ziegelmayer 0ec027dbff
Merge pull request #802 from jerry73204/fix-reading-buf-bug 5 years ago
jerry73204 d60e7cc27d Fix wrong slice index when reading a file 5 years ago
Friedel Ziegelmayer 6d2a43e336
Merge pull request #794 from async-rs/1-6-0 5 years ago
dignifiedquire e1c8638173 chore: release v1.6.0 5 years ago
dignifiedquire 06eea4225b feat: add PartialEq and Eq for channel Errors
Closes #792
5 years ago
Friedel Ziegelmayer 252140839b
Merge pull request #791 from Licenser/patch-1 5 years ago
Heinz N. Gies 69806403c6
Fix readme for BufRead
The `BufRead` readme points to `BufReadExt` being in `async_std::prelude` while it currently lives in `async_std::io::prelude`
5 years ago
Friedel Ziegelmayer 955befd746
Merge pull request #790 from async-rs/1-6-0-beta-2 5 years ago
nasa 70dac51938
Merge pull request #729 from k-nasa/fix_doc_test
Fix doc test
5 years ago
k-nasa d30603affe Merge branch 'master' into fix_doc_test 5 years ago
dignifiedquire c9ecb5bbbd prepare v1.6.0-beta.2 5 years ago
Jacob Rothstein 9e6a76af04
feat: add env vars to configure the runtime threadpool size and name 5 years ago
Friedel Ziegelmayer 2b6c7fedff
Merge pull request #772 from jbr/unixstream-clone 5 years ago
Friedel Ziegelmayer b3277954c7
Merge pull request #776 from azriel91/bugfix/775/wasm-timer-delay 5 years ago
Azriel Hoh baead51a28 Reduces duration in timeout test.
Tries to get CI to pass.
5 years ago
Azriel Hoh e9621af345 Updates `CHANGELOG.md`. 5 years ago
Azriel Hoh d3e59370e7 Switches `wasm-timer` for `futures-timer`. 5 years ago
Jacob Rothstein cd5e17fe87
make UnixStream Clone 5 years ago
Friedel Ziegelmayer e20b0f0d75
Merge pull request #768 from async-rs/fix/file-block
fix(fs): use smol::block_on for drop handling of File
5 years ago
dignifiedquire 19170aead4 use local file 5 years ago
dignifiedquire 2762ec5800 fix(fs): use smol::block_on for drop handling of File
Ref #766
5 years ago
dignifiedquire 247c94ca06 docs(changelog): add missing link 5 years ago
Friedel Ziegelmayer e404dcdd03
Merge pull request #765 from async-rs/feat/1-6-0 5 years ago
dignifiedquire bd6a7e200b prepare v1.6.0-beta.1 5 years ago
Friedel Ziegelmayer e4c4c93d29
Test and fix 32 bit targets 5 years ago
Thayne McCombs 6f6fced103
feat: implement Barrier using Condvar 5 years ago
Friedel Ziegelmayer 10f7abb3b6
Merge pull request #757 from dignifiedquire/feat/smol 5 years ago
dignifiedquire 27c605b4c9 cr: bring back trace call 5 years ago
dignifiedquire faea222b9c fix: use run instead of block_on 5 years ago
dignifiedquire 1214bc2dee increase timeouts 5 years ago
dignifiedquire 26f62aafd9 make wasm deps part of std 5 years ago
dignifiedquire e0928463b1 fix windows traits 5 years ago
dignifiedquire 92532612b7 mark spawn_local unstable 5 years ago
dignifiedquire 1a6d4f6a2f fix windows trait declarations for rawsocket 5 years ago
dignifiedquire 7a9afbd81c update smol 5 years ago
dignifiedquire 280b1a4344 remove invalid doc comment 5 years ago
dignifiedquire 48dd683535 fix feature settings 5 years ago
dignifiedquire 804a52b7fd use published smol 5 years ago
dignifiedquire e4df1405c1 feat: add basic wasm support 5 years ago
dignifiedquire 2cd2ba3530 remove unused dependencies 5 years ago
dignifiedquire 3161a4e449 add some missing windows imports 5 years ago
dignifiedquire 228cc59b3b feat: add spawn_local 5 years ago
dignifiedquire 0a7a52aed5 update to work on smol/master 5 years ago
dignifiedquire 10c8b9a6d8 silence must use 5 years ago
dignifiedquire fd6ae40817 add timeout stress test 5 years ago
dignifiedquire ab9d6554aa switch to smol::Timer 5 years ago
dignifiedquire f5fa0d7e4e avoid boxing futures 5 years ago
dignifiedquire b96afc41dc implement task locals 5 years ago
dignifiedquire 75ab7219df bring back random 5 years ago
dignifiedquire e082634b5e fix spawning 5 years ago
dignifiedquire fc9ee0dfdd keep std::sync::Arc 5 years ago
dignifiedquire 1308fbdf55 switch to smol instead of an internal runtime 5 years ago
dignifiedquire 690ab16587 add dependency 5 years ago
Florian Gilcher 370642ef3e
Merge pull request #734 from sunli829/master
Add async-graphql to the ecosystems inside the readme
5 years ago
Sunli 100c3423c1
Apply suggestions from code review
Thank you.😁

Co-Authored-By: Friedel Ziegelmayer <me@dignifiedquire.com>
5 years ago
nasa 7999e6bf4b
ci: speed up github actions 5 years ago
Fangdun Cai e707ea96e0
docs(readme): add ci status badge 5 years ago
Friedel Ziegelmayer b446cd0230
Merge pull request #748 from async-rs/fix/scheduler-2
fix(rt): bring back dynamic machines
5 years ago
Thayne McCombs db438abb8f
Implement async_std::sync::Condvar (#369)
* Implement async_std::sync::Condvar

Part of #217

* More rigourous detection of notification for condvar

* Use state of Waker instead of AtomicUsize to keep track of if task was
notified.

* Add test for notify_all

* Implement wait_timeout_until

And add warnings about spurious wakeups to wait and wait_timeout

* Use WakerSet for Condvar

This should also address concerns about spurious wakeups.

* Add test for wait_timeout with no lock held

* Add comments describing AwaitNotify struct

And remove an unnneded comment in a Debug implementation
5 years ago
dignifiedquire a4e07e345c fix(rt): bring back dynamic machines
Even if we do not make use of the progress blocking, we do need to make use of the dynamic restarting of machines as far as I understand.

Keeps the perf, while removing the regression from #747
5 years ago
Yoshua Wuyts aebba2bd95
Merge pull request #747 from async-rs/fix/scheduler-perf
Fix new scheduler loop
5 years ago
dignifiedquire 0c9a66c1f6 fix scheduler loop
This now matches more closely the logic as implemented in #631, and fixes the performance regression as far as I have observed.

Closes #746
5 years ago
Friedel Ziegelmayer fc4e472599
Merge pull request #733 from k-nasa/new-scheduler
New scheduler
5 years ago
nasa 6674dc0edf
Merge pull request #739 from devashishdxt/futures-timer-update
Update futures-timer to 3.0.2
5 years ago
k-nasa 088aa5662c refactor: Remove wrapping cell 5 years ago
Devashish Dixit 68fa054517 Update futures-timer to 3.0.2 5 years ago
k-nasa b88138b5d7 kick ci 5 years ago
k-nasa 11ee2a8985 fix 5 years ago
k-nasa 322911142c lock processor and remove unsafe Send, Sync 5 years ago
k-nasa cfaec2aa95 re add spin_lock 5 years ago
sunli 57c648cf01 Add async-graphql to the ecosystems inside the readme 5 years ago
k-nasa 6d3ca5a06f remove poll function 5 years ago
k-nasa f960776846 fix 5 years ago
k-nasa 5c6741724f Merge branch 'master' into new-scheduler 5 years ago
k-nasa 24c5dbf949 Remove scheduler state 5 years ago
nasa 2dbebe54ed
Merge pull request #721 from k-nasa/update_dep_crate
update dependence crates
5 years ago
k-nasa d7ee29a03f fix test code 5 years ago
k-nasa 2b44c1be2e refactor: swap to swap_and_compare 5 years ago
k-nasa b1ec1ea930 Move Spinlock to sync module 5 years ago
k-nasa 2ab075d027 refactor 5 years ago
k-nasa c0f18600cf run ignored test 5 years ago
k-nasa 6c8237276b fix doc test 5 years ago
k-nasa 98cbf7f8eb Restore task::spawn_blocking 5 years ago
k-nasa 84e5c5f351 Merge branch 'master' into new-scheduler 5 years ago
Yoshua Wuyts 3ff9e98f20
Merge pull request #585 from async-rs/try_channels
expose try_recv and try_send on channels
5 years ago
Yoshua Wuyts b7c7efc797 Update try_channel doctests 5 years ago
Yoshua Wuyts 19fd7a4084 fix channel tests
Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>
5 years ago
Yoshua Wuyts 7885c245c5 recverror
Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>
5 years ago
Yoshua Wuyts 7b7b959a6e mark channel errs as unstable
Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>
5 years ago
Yoshua Wuyts 32dce319d3 expose try_recv and try_send on channels
Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>
5 years ago
Yoshua Wuyts 49dd02b4de Make the split struct public 5 years ago
Yoshua Wuyts bb11c676a1 doctests pass 5 years ago
Yoshua Wuyts e026b7579a
Merge pull request #703 from spacekookie/recv-docs
channel/recv: improving function docs and code example
5 years ago
Yoshua Wuyts 51dd7ceb72
Merge pull request #727 from async-rs/revert-719-remove_re_export
Revert "Stabilize most stream method and remove unnecessary macros"
5 years ago
k-nasa 8931d1464e fix ci 5 years ago
nasa cc19592f80
Revert "Stabilize most stream method and remove unnecessary macros" 5 years ago
nasa f69887a50d
Update Cargo.toml 5 years ago
k-nasa 0b0531057d feat: update dependence crates 5 years ago
Yoshua Wuyts 61f9483cc5
Merge pull request #719 from k-nasa/remove_re_export
Stabilize most stream method and remove unnecessary macros
5 years ago
k-nasa f33d7f40ab fix test 5 years ago
k-nasa e3bf89fc05 $cargo fmt 5 years ago
k-nasa ec4b09ecd0 fix test code 5 years ago
k-nasa b95bd6c1fe fix: Remove unnecessary io modules 5 years ago
k-nasa 1e18839f1f fix warning 5 years ago
k-nasa f31878655e fix: Stabilize stream method 5 years ago
k-nasa 9a62df143f add whitespace 5 years ago
k-nasa 75223905bd fix: Stabilize stream most method 5 years ago
k-nasa be60dd9fe7 fix: Remove unnecessary re-export and macros 5 years ago
k-nasa 23b7c174f3 feat: Stabilize io::Std*Lock 5 years ago
Yoshua Wuyts 9167d42f4b
Merge pull request #708 from sunli829/master
Add Xactor to the ecosystems inside the readme
5 years ago
Yoshua Wuyts 4034d58709
Merge pull request #714 from abhijeetbhagat/patch-1
Add missing ? operator after handle.await
5 years ago
abhi 4742f461fe
Add missing ? operator after handle.await
According to line#118, there should be a `?` operator after `await`.
5 years ago
nasa efab39eeaf
Merge pull request #710 from k-nasa/fix_ci_failed
Fixed ci failing
5 years ago
k-nasa bd60cd9f81 run `cargo fmt` 5 years ago
sunli b9e4b6da3e Add Xactor to the ecosystems inside the readme 5 years ago
Yoshua Wuyts eb03f37e43
Merge pull request #697 from async-rs/core-docs
Document the core feature
5 years ago
Yoshua Wuyts d87e283215
Update src/lib.rs 5 years ago
Yoshua Wuyts 283a54a155
Update src/lib.rs 5 years ago
Yoshua Wuyts 3719484eba
Update src/lib.rs
Co-Authored-By: nasa <htilcs1115@gmail.com>
5 years ago
Katharina Fey aae835cc14
channel/recv: improving function docs and code example
At the moment it's not clear when and why recv returns Option<T>,
instead of just T. This changed comment makes it clear that None will
only be returned once no data will ever be sent again (i.e. after all
senders are gone).
5 years ago
Oleg Nosov 68063adddf
Add link to tests 5 years ago
Oleg Nosov d7cab38b67
`core` => `std` 5 years ago
Oleg Nosov 32068942a6
Fixed `flatten` 5 years ago
Oleg Nosov 85c32ef9d2
Use `assert` without `if`-clause 5 years ago
Oleg Nosov b68be72763
Use `assert` instead of `panic` 5 years ago
Oleg Nosov c80915e216
Dont spawn thread in tests 5 years ago
Oleg Nosov 303ac90b7c
Fixed `flat_map` 5 years ago
Yoshua Wuyts d026c44ea3 Document the core feature
Follow-up to https://github.com/async-rs/async-std/pull/680
5 years ago
Yoshua Wuyts 125fa5b0a0
Merge pull request #680 from k-nasa/no_std
Some modules support no_std
5 years ago
Yoshua Wuyts 39f2c6da78
V1.5.0 (#694)
* Update CHANGELOG.md

* v1.5.0

* Update CHANGELOG.md
5 years ago
k-nasa 3e24e0ba4e ci: fix no-std check 5 years ago
k-nasa 0d90cb07b9 fix: Move `extern crate alloc` to lib.rs 5 years ago
k-nasa f789f9d4f6 Select future-core featue according to feature 5 years ago
k-nasa ef985bc72e ci: fix no_std ci 5 years ago
Stjepan Glavina 1d875836a2
Implement Clone for TcpStream (#689)
* Implement Clone for TcpStream

* Update examples

* Remove accidentally added examples
5 years ago
k-nasa 7efe7caf66 fix: Change feature name no-std to alloc 5 years ago
k-nasa 22d929d481 fix import Future 5 years ago
k-nasa d622ec5d35 feat: Make the stream module no_std 5 years ago
k-nasa 880b7ee987 remove crate::prelude import 5 years ago
k-nasa 1762de285b feat: Make the future module no_std 5 years ago
k-nasa 6aa55fde59 feat: Make the task module no_std 5 years ago
k-nasa 41f114d9fe ci: Add no-std check 5 years ago
k-nasa 3d32fd81f4 feat: Make the utils module no_std 5 years ago
k-nasa 51b84a7620 feat: Add no_std attribute when not std feature 5 years ago
k-nasa 4996f29778 feat: Add no-std feature 5 years ago
Toralf Wittner 57974ae0b7 Use non-blocking connect for TcpStream. (#687)
* Use non-blocking connect for TcpStream.

Instead of spawning a background thread which is unaware of any timeouts
but continues to run until the TCP stack decides that the remote is not
reachable we use mio's non-blocking connect.

mio's `TcpStream::connect` returns immediately but the actual connection
is usually just in progress and we have to be sure the socket is
writeable before we can consider the connection as established.

* Add Watcher::{poll_read_ready, poll_write_ready}.

Following a suggestion of @stjepang we offer methods to check for
read/write readiness of a `Watcher` instead of the previous approach to
accept a set of `Waker`s when registering an event source. The changes
relative to master are smaller and both methods look more useful in
other contexts. Also the code is more robust w.r.t. wakeups of the
`Waker` from clones outside the `Reactor`.

I am not sure if we need to add protection mechanisms against spurious
wakeups from mio. Currently we treat the `Poll::Ready(())` of
`Watcher::poll_write_ready` as proof that the non-blocking connect has
finished, but if the event from mio was a spurious one, it might still
be ongoing.
5 years ago
Yoshua Wuyts 57f9fb7e93
Merge pull request #682 from k-nasa/impl_clone_for_dir_entry
Implement Clone trait for DirEntry
5 years ago
Yoshua Wuyts 6c1b5eb3ed
Merge pull request #667 from olegnn/option_take_while
Use `take_while` instead of `scan` in `impl` of `Product`, `Sum` and `FromStream` for `Option` and `Result`
5 years ago
Yoshua Wuyts beb8d240c2
Merge pull request #688 from ninj/patch-1
fix syntax problem for task::sleep
5 years ago
ninj b258215952
fix syntax problem for task::sleep 5 years ago
Florian Gilcher 1ababac97f
Merge branch 'accept_loop_pattern' 5 years ago
Florian Gilcher f9fe5c90cf
Fix some typos in accept-loop pattern chapter 5 years ago
Florian Gilcher 84fe94444b
Merge pull request #675 from k-nasa/add_timeout_example
Add stream::timeout example when timeout error
5 years ago
Florian Gilcher cad2880eb8
Merge pull request #550 from sclaire-1/master
Edit tutorial: implementing_a_client.md
5 years ago
Taiki Endo 6b860c370a Remove usage of unstable format_code_in_doc_comments option (#685) 5 years ago
Katharina Fey 81aa6d152a Changing task::block_on to park after a single poll (#684)
This was previously discussed in #605 and others as a source of high
CPU load when sleeping tasks because of the overhead created by
retrying a future in short succession.
5 years ago
k-nasa 2221441a4c feat: Implement Clone trait for DirEntry 5 years ago
Oleg Nosov ed7ddacb28
Rewrote `Result`s implementation using `take_while` and `filter_map` 5 years ago
nasa d283352a9a update broadcastor to 1.0.0 (#681) 5 years ago
Oleg Nosov ed248017b4
Use internal `scan` state in `Result`s implementation 5 years ago
Yoshua Wuyts 0eb5ca14ac
Merge pull request #676 from k-nasa/async_task_bump_to1.2.1
update async-task to 1.2.1
5 years ago
Oleg Nosov 38de0bfd22
Use `std::convert::identity` 5 years ago
Oleg Nosov 134089af2c
Use `filter_map(identity)` + other fixes 5 years ago
k-nasa b72dd83726 update async-task to 1.2.1 5 years ago
k-nasa ee102dfc9e docs: Add stream::timeout example when timeout error 5 years ago
nasa 1071e82132
Merge pull request #671 from Noah-Kennedy/udp-socket-send-doc
Fix docs for UdpSocket::send
5 years ago
noah 0a52864764 Revert "Fixes https://github.com/async-rs/async-std/issues/652"
This reverts commit a4f68066
5 years ago
noah 76993dd755 Revert "Fixes https://github.com/async-rs/async-std/issues/652"
This reverts commit a4f68066
5 years ago
Yoshua Wuyts 133e30e6f6
Merge pull request #615 from lqf96/pending-stream
Add an implementation of pending stream
5 years ago
nasa 76ed174fd5 Version up of dependent crate (#672) 5 years ago
k-nasa f53fcbb706 test,docs: Add stream::pending example code 5 years ago
k-nasa e9357c0307 style: Run `cargo fmt` 5 years ago
Qifan Lu 879e14c6ab Remove size_hint from Stream impl 5 years ago
Qifan Lu f8dd3d9816 Add stream::pending::{pending, Pending} 5 years ago
noah a4f6806605 Fixes https://github.com/async-rs/async-std/issues/652 5 years ago
Yoshua Wuyts 5d5064b871 add FromStream Result example (#643)
Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>
5 years ago
nasa 0ed0d63094 Remove unnecessary trait bound on FlatMap (#651)
* Remove unnecessary trait bound on FlatMap

* test: upgrade test code
5 years ago
Paul Colomiets 0029037883 async-listen crate: Add `error_hint()` invocation 5 years ago
Oleg Nosov fb567a3a09
Recovered comments 5 years ago
Oleg Nosov 83afbab2ef
Use `take_while` instead of `scan` for `Option` 5 years ago
Paul Colomiets c8c075615c book: Add Production-ready Accept Loop section
Part of the #658 work
5 years ago
Yoshua Wuyts 98d45f4be1
Merge pull request #647 from dignifiedquire/feat/unstable-without-default
feat: do not require default feature for unstable
5 years ago
dignifiedquire 9c6ab5e7c3 fix 5 years ago
dignifiedquire 9c9ab90da3 feature gate random 5 years ago
dignifiedquire 5bf3d95313 feat: do not require default feature for unstable 5 years ago
Yoshua Wuyts 1f78efec64
Merge pull request #660 from mehcode/mehcode-ecosystem
Showcase the ecosystem
5 years ago
Yoshua Wuyts 383057b8ea
Merge pull request #659 from alfiedotwtf/master
Tiny grammar fix
5 years ago
Yoshua Wuyts 763862acc7
Merge pull request #661 from async-rs/fix-ci
remove usage of deprecated Error method to fix CI
5 years ago
Yoshua Wuyts e2bb79c207
Merge pull request #648 from spacekookie/master
Fixing inaccurate function description in udp::recv
5 years ago
Yoshua Wuyts 57a62797f2
Merge pull request #655 from u32i64/patch-1
Fix crate documentation typo
5 years ago
Yoshua Wuyts dfb0c8124c
remove usage of deprecated method
Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>
5 years ago
Ryan Leckey d806a09599 Add a section on the async ecosystem to showcase crates that use async-std 5 years ago
Alfie John af2d46d9b9 Tiny grammar fix 5 years ago
Artem Varaksa 65d7950df1
Fix crate documentation typo 5 years ago
nasa 6d69a3e368
Merge pull request #650 from senden9/patch-1
Fix typo in stream documentation
5 years ago
Stefano Probst c3d5dba1b5
Fix typo in stream documentation 5 years ago
Katharina Fey 081166f204
Fixing inaccurate function description in udp::recv 5 years ago
Yoshua Wuyts fee3b6f603
Merge pull request #645 from async-rs/remove-tokio-mention
update stream::Interval internal comments left over from migration
5 years ago
Yoshua Wuyts b3942ecfa8
remove tokio mention
Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>
5 years ago
Yoshua Wuyts 86d3d74180
Merge pull request #637 from async-rs/v1.4.0
1.4.0
5 years ago
Yoshua Wuyts 3fd6d8b02e
1.4.0
Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>
5 years ago
nasa 0d4b4cd260
Merge pull request #600 from miker1423/future-timeout
Adding timeout extension method to Future trait
5 years ago
Miguel Pérez García ef021dcb2b Changing test condition 5 years ago
Miguel Pérez García eedf1d3367 Fixing docs 5 years ago
Miguel Pérez García 97b4901b75 Fixing tests 5 years ago
Miguel Pérez García 1eeb1019e9 Fixing example 5 years ago
Miguel Pérez García 980a1f7834 Correcting docs on function 5 years ago
nasa d2c25f483a
Merge pull request #635 from async-rs/revert-629-update-log
Revert "upgrade log, remove kv-log-macro"
5 years ago
nasa d8befe24e8
Revert "upgrade log, remove kv-log-macro" 5 years ago
Florian Gilcher c7cf1934db
Merge pull request #629 from async-rs/update-log
upgrade log, remove kv-log-macro
5 years ago
Yoshua Wuyts 37d8a013de
Merge pull request #633 from k-nasa/fix_io_export
fix missing export for the return value
5 years ago
k-nasa 43f4f393af fix missing export for the return value 5 years ago
Stjepan Glavina ceba324bef Fix feature flags 5 years ago
Stjepan Glavina 36d24cd0e1 New scheduler resilient to blocking 5 years ago
Yoshua Wuyts 61eb52cb36
Merge pull request #625 from nbdd0121/sync_unsized
Use ?Sized in Mutex and RwLock
5 years ago
Yoshua Wuyts 6f4dcad6a0
Merge pull request #630 from async-rs/fix-ci-2
fix ci
5 years ago
Yoshua Wuyts 60de8e1082
up time limits
Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>
5 years ago
Yoshua Wuyts cac4e081cc
Merge pull request #628 from fenhl/patch-1
Make WriteFmtFuture must_use
5 years ago
Yoshua Wuyts 8ad1d23116
fix ci
Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>
5 years ago
Yoshua Wuyts 019aa14898
Merge pull request #621 from async-rs/fix-doc-hiccup
fix stream doc hiccup
5 years ago
Yoshua Wuyts b7e55762d8
upgrade log, remove kv-log-macro
Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>
5 years ago
Yoshua Wuyts c70552ead5
unpub double_ended_stream
Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>
5 years ago
Fenhl 07eb2c1280
Make WriteFmtFuture must_use
Fixes #627. Thanks to @jebrosen for pointing out the location of the issue.
5 years ago
Gary Guo 732ef10f98 Make code compile 5 years ago
Gary Guo 499a44ab3b Use ?Sized in Mutex and RwLock 5 years ago
Yoshua Wuyts 761029cd08
fix stream doc hiccup
Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>
5 years ago
Yoshua Wuyts 83a488b290
Merge pull request #597 from k-nasa/fix_doc_test
Fix failed doc test and enable doc test on CI
5 years ago
Yoshua Wuyts 2f0907714d
Merge pull request #617 from async-rs/1.3.0
1.3.0
5 years ago
Yoshua Wuyts 055c64e8a7
1.3.0
Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>
5 years ago
Yoshua Wuyts 96d6fc43d6
Merge pull request #618 from twittner/poll_close_shutdown
TcpStream: Shutdown write direction in poll_close.
5 years ago
Yoshua Wuyts 3d3bf914ea
Merge pull request #562 from felipesere/double_ended_ext
DoubleEndedStream extension
5 years ago
Miguel Pérez García 84b6d2b276 Removing duplicated tests 5 years ago
Miguel Pérez García 8de9f9b8e1 Merge branch 'future-timeout' of https://github.com/miker1423/async-std into future-timeout 5 years ago
Felipe Sere 182fe6896f No need for a custom impl for FromIter for DoubleEndedStream 5 years ago
Felipe Sere b0038e11be Only implement the DoubleEndedStream for once when the flag is on 5 years ago
Felipe Sere 8e5dedec34 Restructure package. No longer use a extension trait to match std.
Still outstanding: How do I hide the concrete structs from the trait?
5 years ago
Felipe Sere 41cf0f855b Make Once a DoubleEndedStream 5 years ago
Felipe Sere f9a4c35fd6 Silence warning about missing docs for the double_ended module 5 years ago
Felipe Sere 6e8236d0e1 Document from_iter for DoubleEndedStream 5 years ago
Felipe Sere 892c6008c2 Replace sample with a hidden from_iter implementation for double-ended-stream 5 years ago
Felipe Sere abd360893c Disable docs and Debug for unexposed structs 5 years ago
Felipe Sere 94893d2924 Move more of the documentation 5 years ago
Felipe Sere 02aa2f3d2a Fix next_back 5 years ago
Felipe Sere ee2f52f3ce Add next_back 5 years ago
Felipe Sere 55194edbf7 Add try_rfold 5 years ago
Felipe Sere c4b9a7f680 Add samples for some of the functions 5 years ago
Felipe Sere aabfefd015 Add a sample implementation of a double ended stream 5 years ago
Felipe Sere cc493df433 Sketch out rfold 5 years ago
Felipe Sere 78bafbb88f Sketch outch rfind 5 years ago
Felipe Sere d0ef48c753 Sketch out nth_back 5 years ago
Felipe Sere fa288931c6 Skeleton for DoubleEndedStreamExt trait 5 years ago
Toralf Wittner c90732a805 TcpStream: Shutdown write direction in poll_close.
Fixes #599.
5 years ago
Yoshua Wuyts 63b6a2b961
Merge pull request #614 from killzoner/doc-typo-await
fix: Fix typo in documentation
5 years ago
Yoshua Wuyts 1103c17e16
Merge pull request #613 from k-nasa/fix_readme
Readme example simply compile
5 years ago
Yoshua Wuyts a0f3b3b753 Remove unused macros (#610)
* replace async-macros with internals only

Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>

* clean up MaybeDone

Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>

* inline futures_core::ready

Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>

* remove big commented blob

Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>
5 years ago
Tomasz Miąsko f06ab9fbc4 Remove mention of task stack size configuration (#612) 5 years ago
svengrim 447c17128f
fix: Fix typo in documentation 5 years ago
k-nasa a04157850b fix readme 5 years ago
nasa 9311fd7fae
Merge pull request #595 from linkmauve/patch-1
docs: Replace mention of futures-preview crate
5 years ago
nasa f7b21a3e8d
Merge pull request #608 from dungph/master
fix link to `task/block_on` on README.md
5 years ago
Dung Pham f0bdcfec25
fix link 5 years ago
Miguel Pérez García 33e7c87dfc Adding example to docs 5 years ago
Miguel Pérez García cc85533f7c fixing format 5 years ago
Miguel Pérez García 4670388a56 Adding tests 5 years ago
Miguel Pérez García c14c377974 Changing method signature 5 years ago
Miguel Pérez García 54fa559554 Changing scope of disclosure 5 years ago
Yoshua Wuyts bce8688763
Merge pull request #603 from bluk/udp-socket-recv-doc
Change recv_from to recv in UdpSocket::recv doc
5 years ago
Bryant Luk fd86effb63
Change recv_from to recv in UdpSocket::recv doc 5 years ago
nasa 128a6bc6ce
Merge pull request #598 from povilasb/fix/docs
Fix a link in the docs
5 years ago
Yoshua Wuyts d51a135015
Merge pull request #309 from async-rs/stream-delay
Stream::delay
5 years ago
Miguel Pérez García 1c2055fff0 Merge remote-tracking branch 'original/master' into future-timeout 5 years ago
Povilas Balciunas 81e3c41826 Fix a link in the docs 5 years ago
k-nasa fb1fb6c903 test: Test the delay time 5 years ago
k-nasa c85e2496b1 Enable doc test on ci 5 years ago
k-nasa 7d9a063002 fix cargo test arguments on ci 5 years ago
k-nasa 44e38eae59 fix open_file test code 5 years ago
k-nasa fe04cf26b6 test: fix stream::throttle doc test 5 years ago
k-nasa 556d7992ce test: fix failed doc test 5 years ago
k-nasa da965e9ba4 fix indent 5 years ago
k-nasa 9f7c1833dc fix module 5 years ago
linkmauve 55560ea9b4
docs: Replace mention of futures-preview crate
It is now stable in 0.3.
5 years ago
Stjepan Glavina bf9ee88815 Fix a typo 5 years ago
Stjepan Glavina 9627826756 Bump the version to 1.2.0 5 years ago
Stjepan Glavina 4ed15d67c9 Fix links in the changelog 5 years ago
Stjepan Glavina 0165d7f6d1 Add missing items to the changelog 5 years ago
Yoshua Wuyts dba416608a 1.2.0 (#589)
Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>
5 years ago
Yoshua Wuyts 68005661d9 fix Stream::throttle hot loop (#584)
Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>
5 years ago
nasa 794e331761 Refactor join type (#577)
* refactor: update future join type

* test: update future join test

* update future::try_join
5 years ago
Yoshua Wuyts 63f7ea3081
Merge pull request #587 from async-rs/contributing
link to our contribution guidelines
5 years ago
k-nasa 32765ece41 test: Add stream::delay test code 5 years ago
k-nasa 635c592950 feat: Add stream::delay 5 years ago
k-nasa 3b055f364e Merge branch 'master' into stream-delay 5 years ago
Yoshua Wuyts 46cafffc31
Merge pull request #571 from killercup/more-errors
Add context to more errors
5 years ago
boats 0f30ab8c0a Fix the docs and Debug output of BufWriter. (#588)
The BufWriter docs inaccurately stated that it flushes on drop, which it does
not do. This PR changes the docs, as well as the example, to highlight that
the user must explicitly flush a bufwriter.

There were also two places where the BufWriter code referred to it as a
BufReader: in the link to the std docs, and in the Debug output. Those have
also been fixed.
5 years ago
Yoshua Wuyts e66e2e2b8f
link to our contribution guidelines
Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>
5 years ago
Pascal Hertleif 56538ebd91 Improve verbose errors for socket addresses
Moves the point of adding error context to the net::addr module so that
we have access to the raw address input and can include it in the error
message.
5 years ago
Pascal Hertleif aa7d1c27a4
Verbose errors: Apply suggestions
Co-Authored-By: Yoshua Wuyts <yoshuawuyts+github@gmail.com>
5 years ago
Yoshua Wuyts 850b8ae9d0
Merge pull request #543 from k-nasa/stream_unzip
Add stream unzip
5 years ago
Yoshua Wuyts ac7a796f82
Merge pull request #537 from k-nasa/ci_master
Enable CI on master branch
5 years ago
Miguel Pérez García c1f7be5d42 Adding timeout extension method to Future trait 5 years ago
Yoshua Wuyts 50cefce803
Merge pull request #561 from async-rs/1.1.0
1.1.0
5 years ago
Yoshua Wuyts 3780ff7b44
1.1.0
Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>

changelog

Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>
5 years ago
Yoshua Wuyts c9a2e74789
Merge pull request #523 from async-rs/update-lib-example
polish lib.rs examples
5 years ago
Yoshua Wuyts cffacf7fa3
feedback from review
Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>
5 years ago
Yoshua Wuyts 02e1d7e5ea
Merge pull request #574 from stjepang/ignore-unread-errors
Ignore seek errors in poll_unread
5 years ago
laizy ec5415358f simplify AllFuture and AnyFuture (#572) 5 years ago
Alejandro Martinez Ruiz ba1ee2d204 Fix a-chat tutorial issues (#573)
* tutorial/receiving_messages: fix future output type bound

* tutorial/receiving_messages: remove unneeded message trimming

Trimming was done twice on messages, so one of the two instances can
be removed. I personally think removing the first instance, in which
we are splitting names from messages makes the code more readable
than removing the second instance, but other examples further in
the tutorial show the second instance removed.

* tutorial/receiving_messages: declare use of TcpStream and io::BufReader

Readers couldn't see the `use` lines corresponding to these two
structures.

* tutorial/connecting_readers_and_writers: typos and grammar fixes

* tutorial/all_together: remove unneeded use async_std::io

* tutorial: use SinkExt consistently from futures::sink::SinkExt

* tutorial/handling_disconnection: hide mpsc use clause and remove empty lines

The empty lines translate to the output making it look weird.

* tutorial/handling_disconnection: fix typos

* tutorial/handling_disconnection: use ? in broker_handle.await

We were happy to return an Err variant from the broker_handle before
and nothing has changed in this regard, so bubbling it up to run().
5 years ago
Stjepan Glavina 16edec3464 Ignore seek errors in poll_unread 5 years ago
Pascal Hertleif e01f07d72a Add context to more errors
cc #569
5 years ago
Yoshua Wuyts b3d30de4a1 mark windows fs APIs as "unstable" (#567)
Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>
5 years ago
Yoshua Wuyts 6f19165e0e
Merge pull request #568 from stjepang/fix-random
Fix rng use in Stream::merge
5 years ago
nasa d146d95a39
Update src/stream/stream/mod.rs
Co-Authored-By: Taiki Endo <te316e89@gmail.com>
5 years ago
Stjepan Glavina 5fba3a0928 Fix rng use in Stream::merge 5 years ago
Yoshua Wuyts 2ca03cabe6
Merge pull request #552 from hhggit/win_symlink
add os::windows::symlink_{dir,file}
5 years ago
hhggit 72ed4eb4fd
Update mod.rs 5 years ago
Yoshua Wuyts 77800ab3f9
Merge pull request #526 from yjhmelody/refactor-dir
refactor io dir to be same with std and export IntoInnerError
5 years ago
Yoshua Wuyts 8ea920c9f0
Merge pull request #546 from k-nasa/fix_clippy
Fix clippy warn
5 years ago
Yoshua Wuyts d1189f9974
Merge pull request #548 from yjhmelody/fix-stream-code-style
fix stream code style
5 years ago
Yoshua Wuyts 3f8ec5a007
Merge pull request #551 from killercup/feature/verbose-errors
verbose errors feature
5 years ago
nasa 3bc4d293dd
Merge pull request #503 from Razican/random_merge
Randomize Stream::merge to improve the throughput.
5 years ago
Yoshua Wuyts f24b3a4520
Merge pull request #559 from k-nasa/fix_max_by_key
Fix stream max_by_key and min_by_key
5 years ago
razican 72ca2c1a24
Improved the code with some minor changes 5 years ago
k-nasa b5e66c4f93 refactor: Refactoring option type handling 5 years ago
k-nasa 080875edc9 update min_by_key doc 5 years ago
k-nasa ca71ad073b fix stream min_by_key mistake 5 years ago
k-nasa 667bbc1019 doc: update doc test 5 years ago
k-nasa 64b2e10b93 fix max_by_key mistake 5 years ago
k-nasa 314a75da28 fix typo 5 years ago
Pascal Hertleif c704643296 Remove verbose-errors cargo feature 5 years ago
Yoshua Wuyts c6622475b2
Merge pull request #555 from stjepang/optimize-cargo-check
Macro optimization to reduce compilation times
5 years ago
Stjepan Glavina 65afd41a33
Once doesn't need Unpin bound (#554) 5 years ago
Stjepan Glavina d3e7f32a30 Macro optimization to reduce compilation times 5 years ago
Razican f6829859fe
Fixed deduplication of code 5 years ago
hhggit 2c9b558d14 add os::windows::symlink_{dir,file} 5 years ago
Pascal Hertleif 99ddfb3f93 Wrap code more clearly in cfg blocks 5 years ago
Pascal Hertleif 8ce3e78952 verbose errors feature
This adds a new "verbose-errors" feature flag to async-std that enables
wrapping certain errors in structures with more context. As an example,
we use it in `fs::File::{open,create}` to add the given path to the
error message (something that is lacking in std to annoyance of many).
5 years ago
sclaire-1 b2aaa8b825
Edit tutorial: implementing_a_client.md
Edited to improve reading flow
5 years ago
yjhmelody 223fcc30ee fix code style for stream 5 years ago
k-nasa 76975a4441 Merge branch 'master' into fix_clippy 5 years ago
Yoshua Wuyts 355e2eded8
Merge pull request #547 from async-rs/unpin-successors-test
remove pin_mut from successors test
5 years ago
Yoshua Wuyts 6cc9e4dd2b
Merge pull request #544 from async-rs/update-futures-timer
update futures-timer & other deps
5 years ago
Yoshua Wuyts ee23ba6e94
Merge pull request #545 from yjhmelody/stream-partition-patch
use `as_mut` for stream-partition
5 years ago
Yoshua Wuyts d68dc659b2
remove pin_mut from successors test
Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>
5 years ago
Yoshua Wuyts b5c3fb8bb5
Merge pull request #363 from felipesere/async-successors
Async successors
5 years ago
k-nasa 7d616c695d refactor: change to as_mut 5 years ago
yjhmelody a69b3a8a9e use `as_mut` for stream-partition 5 years ago
k-nasa a05b6a3810 fix: mutable ref 5 years ago
k-nasa 6cbf48f12d fix clippy warn 5 years ago
k-nasa 91ee4c7b9f doc: Add stream unzip doc 5 years ago
k-nasa 603b3c5085 add: Add stream unzip 5 years ago
Yoshua Wuyts 693a7257b8
Merge pull request #538 from k-nasa/stream_by_ref
Add stream by_ref
5 years ago
Yoshua Wuyts 8779c04dc7
upgrade all deps
Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>
5 years ago
Yoshua Wuyts 3564be9c0c
update futures-timer dep
Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>
5 years ago
k-nasa df92c63337 fix: Add unstable features 5 years ago
k-nasa 31cf932d80 wip: Add stream unzip 5 years ago
Yoshua Wuyts 3c6d41ccb4
Merge pull request #541 from yjhmelody/stream-partition
add stream-partition
5 years ago
Yoshua Wuyts 837604b833
Merge pull request #542 from yjhmelody/update-doc
update doc url
5 years ago
yjh 74caed2d4b
Update src/io/seek/mod.rs
Co-Authored-By: Taiki Endo <te316e89@gmail.com>
5 years ago
yjhmelody 76ec9c4563 update doc url 5 years ago
yjhmelody d76b32e6d4 make it unstable and fix trait bound 5 years ago
yjhmelody 11268a80fb add stream-partition 5 years ago
Yoshua Wuyts c4ba11ff95
Merge pull request #535 from async-rs/docs-sender-recv
backlink channel types
5 years ago
k-nasa de67bf0fd4 feat: Add stream by_ref 5 years ago
k-nasa 4ef55d4d7b Enable CI on master branch 5 years ago
nasa 77a0419a3e
Merge pull request #536 from async-rs/count-unstable
mark Stream::count as unstable
5 years ago
Yoshua Wuyts ce98834039
Merge pull request #531 from sclaire-1/master
Edit tutorial index.md
5 years ago
Yoshua Wuyts 30ff7b09b6
mark Stream::count as unstable
Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>
5 years ago
Yoshua Wuyts c58747b5fc
Merge pull request #368 from starsheriff/stream_count
add stream::count
5 years ago
Yoshua Wuyts 31f129ebe7
backlink channel types
Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>
5 years ago
Yoshua Wuyts f49d7cbbb8
Merge pull request #533 from async-rs/remove-throttle-example
remove standalone throttle example
5 years ago
Felipe Sere 64216b8e6b Take a normal closure, not an async one 5 years ago
Felipe Sere 786a52a09d Slight miss-merge 5 years ago
Felipe Sere f14b37ff17 Remoe the T: Copy bound on the item 5 years ago
Felipe Sere 7677e9a3df Make the closure take a borrow to the value 5 years ago
Felipe Sere bfb42b432e Rearrange docs to match 'repeat' 5 years ago
Felipe Sere 4c09cdbeac Mark successors as unstable 5 years ago
Felipe Sere 243cdd7ff1 Slight miss-merge 5 years ago
Felipe Sere a257b7018c Rename some variables to match iter 5 years ago
Felipe Sere af928163e4 Got further! Thx Josh! 5 years ago
Felipe Sere 8d97e0f974 Only produes empty value if next is ever a 'None' 5 years ago
Felipe Sere 266754897e Rename the module to 'successors' 5 years ago
Felipe Sere 554d5cfbc1 Slight renamings 5 years ago
Felipe Sere 8b662b659d Run rustfmt 5 years ago
Felipe Sere 95a3e53fcd Only use the Option of the future to decide to construct a new one 5 years ago
Felipe Sere 02b261de10 It compiles! Store the future and poll it instead of creating multiple new ones 5 years ago
Felipe Sere fe3c9ef626 First attempt at successor 5 years ago
Yoshua Wuyts 4e1d79adb1
Merge pull request #524 from yjhmelody/stream-max
Add Stream max
5 years ago
Yoshua Wuyts 1546448800
remove throttle example
Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>
5 years ago
Yoshua Wuyts 338273eb18
Merge pull request #356 from Wassasin/342-stream-throttle
Implemented StreamExt::throttle
5 years ago
Wouter Geraedts dda65cbff0 Start throttle measurement before initialisation 5 years ago
Johannes Weissmann 9ebe41f2d6
Update src/stream/stream/mod.rs
Co-Authored-By: nasa <htilcs1115@gmail.com>
5 years ago
Wouter Geraedts 90c67c223a Decreased throttle test time to original values; only test lower bound 5 years ago
sclaire-1 8473b738d0
Edit tutorial index.md
Edited the structure of sentences to make it easier to read
5 years ago
Stjepan Glavina 0c2282ffdc
Optimization: a slot for the next task to run (#529)
* Optimization: a slot for the next task to run

* Only notify workers when a task is pushed into a queue
5 years ago
Florian Gilcher d546ee3d92
Merge pull request #528 from skade/remove-nightly-note
Update version requirements in the tutorial
5 years ago
Florian Gilcher 6338341369
Merge pull request #520 from gierlachg/stream_pinning
Cleaning up stream pinning.
5 years ago
Florian Gilcher 6f4bea07a1
Update version requirements in the tutorial 5 years ago
yjhmelody 5adb112a00 export IntoInnerError for io 5 years ago
yjhmelody 9d634cb2a7 refactor io dir to be same with std 5 years ago
yjhmelody 879af6dc85 Add Stream max 5 years ago
Yoshua Wuyts 79962e20a5
enable attributes feature
Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>
5 years ago
Yoshua Wuyts 1431ee0422
polish README.md examples
Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>
5 years ago
Yoshua Wuyts 2dfdc1c482
polish lib.rs examples
Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>
5 years ago
Grzegorz Gierlach e442eba625 Cleaning up stream pinning. 5 years ago
Grzegorz Gierlach f0875d2dca Cleaning up stream pinning. 5 years ago
Devashish Dixit f611ceccc8 Run cargo fmt for doc comments (#515) 5 years ago
Yoshua Wuyts 74a7d93611 upgrade async-macros to 2.0.0 (#519)
Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>
5 years ago
Wouter Geraedts c5b3a98e5b Increased throttle test to 10x time 5 years ago
Yoshua Wuyts 3151a70b77
Merge pull request #517 from Alexendoo/surf
Enable surf example
5 years ago
Wouter Geraedts 4ab7b213de Updated example to be consistent; added timing measurements to throttle 5 years ago
Wouter Geraedts 6990c1403f Reimplemented throttle to never drop Delay, added boolean flag 5 years ago
Wouter Geraedts 77a1849303 Merge branch '342-stream-throttle' of github.com:Wassasin/async-std into 342-stream-throttle 5 years ago
Wouter Geraedts a722de1a10 Merge remote-tracking branch 'upstream/master' into 342-stream-throttle 5 years ago
Wouter Geraedts 88cbf2c119 Change throttle test to run in milliseconds 5 years ago
Wouter Geraedts 6f6d5e9d20
Updated throttle fn comments.
Co-Authored-By: Yoshua Wuyts <yoshuawuyts+github@gmail.com>
5 years ago
Wouter Geraedts 7c7386735e
Wrap around throttle comment
Co-Authored-By: Yoshua Wuyts <yoshuawuyts+github@gmail.com>
5 years ago
Alex Macleod 1b7d5bea6b Enable surf example
1.0.3 has been released with the required change
5 years ago
Yoshua Wuyts 46c58b214c
Merge pull request #514 from async-rs/stabilize-yield-now
stabilize task::yield_now
5 years ago
Yoshua Wuyts 0d5c7a217f
stabilize task::yield_now
Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>
5 years ago
Yoshua Wuyts 5017117326
Merge pull request #513 from async-rs/fix-changelog
fix changelog
5 years ago
Yoshua Wuyts 9d7b2d6696
fix changelog
Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>
5 years ago
Yoshua Wuyts 643b678ea5
Merge pull request #511 from async-rs/1.0.1
1.0.1
5 years ago
Yoshua Wuyts b5b2b5a0a3
1.0.1
Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>
5 years ago
Florian Gilcher 54371c21c1
Merge pull request #510 from stjepang/fix-spawn-blocking
Improve thread startup/shutdown algorithm in spawn_blocking
5 years ago
Stjepan Glavina 1a50ffd144 Delete unused import 5 years ago
Stjepan Glavina 21c5c48cb6 Lower the timeout to 1 second 5 years ago
Stjepan Glavina 6677d52c2d Improve thread creating algorithm in spawn_blocking 5 years ago
Johannes Weissmann 37922408e5 use pin_project 5 years ago
Johannes Weissmann 7d2282dbd2 fix merge conflict 5 years ago
Johannes Weissmann 60f822bee5 Merge branch 'master' into stream_count 5 years ago
CosciaDiPollo 9ad0cf9f80 Correct a typo on the async-std version (#508)
Correct a typo on the async-std version in the Cargo.toml file of the documentation.
5 years ago
Yoshua Wuyts 980c30e90f
Merge pull request #496 from async-rs/1.0.0
1.0.0
5 years ago
Yoshua Wuyts 4aa9928ece
v1.0.0
Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>
5 years ago
Yoshua Wuyts eea7af24db
fix bugs in changelog
Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>
5 years ago
Yoshua Wuyts 76c5ffe9ab
Merge pull request #506 from stjepang/cleanup-stream
Cleanup stream module
5 years ago
Stjepan Glavina 5438258cee Remove unused import 5 years ago
Wouter Geraedts ef958f0408 Use pin_project_lite instead for throttle 5 years ago
Stjepan Glavina dc5d143c16 Merge branch 'master' into cleanup-stream 5 years ago
Stjepan Glavina c2f750d288 Cleanup stream module 5 years ago
Wouter Geraedts 139a34b685 Make throttle an unstable feature 5 years ago
Wouter Geraedts b591fc68bd Changed semantics of throttle to non-dropping variant with backpressure 5 years ago
razican 5d558ca213
Fixed test, order is no longer guaranteed 5 years ago
razican e48e463736
Duplicating code due to strange Rust error. 5 years ago
razican 0c37d4af10
Anonymous function to avoid type issues 5 years ago
Stjepan Glavina 352f18bc2a
Use async_std::sync::Arc in examples (#501) 5 years ago
razican 79bbf4938d
Randomize Stream::merge to improve the throughput. Implements #490. 5 years ago
Wouter Geraedts 14d7d3bf9c Merge remote-tracking branch 'upstream/master' into 342-stream-throttle 5 years ago
Stjepan Glavina 417b548692
Cleanup path module (#497)
* Cleanup path module

* Derive clone for PathBuf and remove unused import

* impl AsRef<Path> for std::path::PathBuf

* Fix a doc comment
5 years ago
Stjepan Glavina 122e87364b Remove cache padding in channels 5 years ago
Yoshua Wuyts 925b42bc89
Merge pull request #493 from stjepang/cleanup-future
Cleanup future module
5 years ago
Stjepan Glavina d4f38e783f Cleanup future module 5 years ago
Yoshua Wuyts 96d3560742 remove future::*join macros (#492)
Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>
5 years ago
Yoshua Wuyts ac1042a9ca note on Stream::merge ordering (#491)
* note on Stream::merge ordering

Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>

* Update src/stream/stream/mod.rs
5 years ago
Stjepan Glavina 9e185f1c3e
Unstable feature: copy takes arguments by value (#471)
* Unstable feature: copy takes arguments by value

* Fix feature flags
5 years ago
Yoshua Wuyts 89d611628a
Merge pull request #483 from ryan-scott-dev/rscott/pathbuf_fromiter
Add FromIterator and Extend trait implementations for PathBuf
5 years ago
Yoshua Wuyts e9c0f8f6b5
Merge pull request #481 from async-rs/fix-proc-macro-render
fix attributes feature
5 years ago
Yoshua Wuyts 16565ccfbc
Merge pull request #489 from jaysonsantos/pathbuf-fromstr
Implement FromStr for PathBuf
5 years ago
Yoshua Wuyts 74882c119d
check attributes
Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>
5 years ago
Jayson Reis d8e52c1002
Implement FromStr for PathBuf
This makes PathBuf compatible with std version as you can simply call
let path: PathBuf = FromStr::from_str(s).unwrap()
5 years ago
Yoshua Wuyts 037119c0c0
Merge pull request #478 from portgasd666/master
Add Future::join and Future::try_join
5 years ago
Stjepan Glavina 548733e5d5
Cleanup stream traits (#487)
* Cleanup stream traits

* Fix docs
5 years ago
Abhishek C. Sharma f04b6f6fe9 Change module level docs for future to refer to join and try_join functions instead of macros 5 years ago
Friedel Ziegelmayer 4a78f731b7 fix: stream::take_while (#485)
When the predicate is false, the stream should be ended.
5 years ago
nasa d2d63348c7 Stable and beta add to CI (#482)
* Add stable and beta

* Add benches
5 years ago
Ryan Scott 8f3366072f Add FromIterator and Extend trait implementations for PathBuf 5 years ago
Yoshua Wuyts e74e246bbb
fix attributes feature
Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>
5 years ago
laizy fb19ebde17 add `Sync` constraint for RwLock to prevent memory unsafety (#479) 5 years ago
Abhishek C. Sharma b14282457c Add Future::join and Future::try_join 5 years ago
Stjepan Glavina ab2f64cd84 Mark extend() as unstable 5 years ago
Yoshua Wuyts fd088fea38 0.99.12 (#469)
* 0.99.12

Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>

* Update changelog with latest changes
5 years ago
Yoshua Wuyts 335bd34470 Add "std" feature flag (#476)
* core feature

Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>

* introduce std + default features

Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>

* test std features on ci

Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>

* finish up all features

Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>

* Fix task_local macro

* Remove crossbeam-channel and futures-timer from std

* Move future::timeout() behind cfg_default
5 years ago
Stjepan Glavina f588ba6bdd
Spawn more than one blocking thread (#475)
* Spawn more than 1 blocking thread

* Fix a bug

* Fix check when the thread is last sleeping
5 years ago
Yoshua Wuyts 84880c4d8b re-export async-attributes (#238)
* re-export async-attributes

Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>

* doc order

Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>

* rebase + rename feature to "attributes"

Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>

* only expose test and main

Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>

* async-attributes 1.1.0

Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>
5 years ago
Stjepan Glavina bc24503382
Fix deadlock when all receivers are dropped (#474)
* Fix deadlock when all receivers are dropped

* Add a comment to explain the behavior of try_send

* Disable clippy
5 years ago
Yoshua Wuyts 266e6326eb document path submodule (#467)
Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>
5 years ago
Stjepan Glavina f8e82564d9
Rename stream_extend to extend (#464)
* Rename stream_extend to extend

* Remove Extend from prelude

* Add stream::extend()
5 years ago
Abhishek C Sharma eb1ef3f4e4 Minor documentation fix for race and try_race (#473) 5 years ago
Yoshua Wuyts d0f1996759
Merge pull request #388 from felipesere/cycle
Implement stream::cycle(..)
5 years ago
Yoshua Wuyts 8a0e29473a
Merge pull request #446 from yjhmelody/stream-cloned
Add Stream cloned
5 years ago
Yoshua Wuyts 2cb887e154
Merge pull request #465 from async-rs/non-pub-flatten
hide future::Flatten::new
5 years ago
Yoshua Wuyts 929027796e
hide future::Flatten
Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>
5 years ago
Yoshua Wuyts 9a8805678e
Merge pull request #443 from portgasd666/master
Added Future::flatten
5 years ago
Yoshua Wuyts a064a5b13e
Merge pull request #459 from stjepang/expose-ext-traits
Expose extension traits in preludes
5 years ago
Stjepan Glavina c34e0f8a35
Update futures to 0.3 (#463)
* Update futures to 0.3

* Fix a search-and-replace error

* Fix imports in tests

* Fix an import
5 years ago
Stjepan Glavina 93b01e36ed
Clippy fixes (#462) 5 years ago
Gabriel Majeri d502453057 Remove doc `Stream` impl for `VecDeque` (#461) 5 years ago
Yoshua Wuyts 3144e217ae
Merge pull request #458 from async-rs/rework-intro
rework lib.rs docs
5 years ago
Stjepan Glavina c3254d78d9 Fix a re-rexport 5 years ago
Yoshua Wuyts f4fb8a3534
change one line
Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>
5 years ago
Yoshua Wuyts 1c87e97e9c
Apply suggestions from code review
Co-Authored-By: Stjepan Glavina <stjepang@gmail.com>
5 years ago
Stjepan Glavina a757cc02dc Expose extension traits in preludes 5 years ago
Yoshua Wuyts ae8b051892
rework lib.rs docs
Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>
5 years ago
Stjepan Glavina 1707638ebb
Update mod.rs 5 years ago
Yoshua Wuyts 84fa4ca068
Merge pull request #456 from stjepang/doc-fixes-links
Fix some links in docs
5 years ago
Stjepan Glavina 43bb59cd02 Fix some links in docs 5 years ago
yjh 5179f30d2d
use async_std::stream 5 years ago
yjh a35602f375
Update mod.rs 5 years ago
Yoshua Wuyts e14cc2a30d
Merge pull request #452 from stjepang/fix-deadlocks
Fix a deadlock in channel
5 years ago
Stjepan Glavina 6d421de992 Fix another clippy warning 5 years ago
Stjepan Glavina 5874392397 Fix a clippy warning 5 years ago
Stjepan Glavina e9edadffc7 Fix a deadlock in channel 5 years ago
Yoshua Wuyts 282ae064fe
Merge pull request #449 from async-rs/strip-vecdeque
remove remaining instances of VecDeque stream
5 years ago
yjh e85bbe68e6
Merge branch 'master' into stream-cloned 5 years ago
Abhishek C. Sharma d7afcada76 Fixed ambiguous associated types 5 years ago
Abhishek C. Sharma e36172e808 Merge remote-tracking branch 'upstream/master' 5 years ago
Abhishek C. Sharma a3e68704bc Wrap state enum in public struct 5 years ago
yjh 8bef812e78
Update src/stream/stream/cloned.rs
Co-Authored-By: nasa <htilcs1115@gmail.com>
5 years ago
yjh bf0cd5987a
Update src/stream/stream/cloned.rs
Co-Authored-By: nasa <htilcs1115@gmail.com>
5 years ago
Stjepan Glavina 20cdf73bb0
Simplify RwLock using WakerSet (#440) 5 years ago
Yoshua Wuyts ed1cb49807
remove remaining instances of VecDeque stream
Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>
5 years ago
Stjepan Glavina 78614c6c1d
Clarify blocking in channel docs (#448) 5 years ago
nasa ddbbbfc32a Replace `VecDeque` with `stream::from_iter` in examples (#447) 5 years ago
yjhmelody 4942dc7f9f Add Stream cloned 5 years ago
Abhishek C. Sharma e0910be8fb Added Future::flatten 5 years ago
Felipe Sere 57a6516e63 Make bounds on Stream impl simpler 5 years ago
Felipe Sere fbd5bd867d Revert "Only one generic type needed"
This reverts commit e9b9284863a614b852c22d58205cb983fc26682a.
5 years ago
Felipe Sere 9ee804f9ed Only one generic type needed 5 years ago
Felipe Seré eaa56580e3 Update src/stream/stream/mod.rs
Co-Authored-By: Yoshua Wuyts <yoshuawuyts+github@gmail.com>
5 years ago
Felipe Sere 0186124aef Simpler impl 5 years ago
Felipe Sere 197253aa73 Run fmt 5 years ago
Felipe Sere 19381fa590 One clippy warning 5 years ago
Felipe Sere ed5b095c73 Run fmt 5 years ago
Felipe Sere 5aadc5e4e9 Make cycle a function on the stream type 5 years ago
Felipe Sere b979773505 Follow clippys advice 5 years ago
Felipe Sere fd09e2f248 Run fmt 5 years ago
Felipe Sere 171cc82aed Replace copy with clone bound 5 years ago
Felipe Sere 83ff11ff4c Switch cycle to stream 5 years ago
Felipe Sere e1ba87e7c1 Add slightly better docs 5 years ago
Felipe Sere 8126bb1882 use the module operator to calculate next index 5 years ago
Felipe Sere 486f9a964c Cycle over a known set of values. 5 years ago
Felipe Sere a096d5ec2d stub out an example 5 years ago
Felipe Sere dea1b67670 Skeleton cycle 5 years ago
Aleksey Kladov fa91d7f856 Stream::merge does not end prematurely if one stream is delayed (#437)
* Stream::merge does not end prematurely if one stream is delayed

* `cargo test` without features works

* Stream::merge works correctly for unfused streams
5 years ago
Yoshua Wuyts 9a4f4c591c
Merge pull request #441 from async-rs/stdio-lock-unstable
mark stdio-lock structs as unstable
5 years ago
Yoshua Wuyts 6f9436e575
mark stdio-lock structs as unstable
Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>
5 years ago
Yoshua Wuyts 735fa6954e Replace select!/try_select! with Future::{race,try_race} (#405)
* init Future::select

Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>

* implement Future::select

Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>

* try_select

Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>

* fixes

Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>

* works

Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>

* pass clippy

Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>

* please clippy

Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>

* implement feedback from stjepan

Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>

* rename select to race

Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>

* fmt

Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>
5 years ago
yjh 3a2e6d5b92 add max_by_key (#408)
* add max_by_key

* fix conflict

* fmt code
5 years ago
Zhang Guyu 5fb9d3e980 add Stream::copied (#442) 5 years ago
Yoshua Wuyts 4c63392a85
Merge pull request #334 from k-nasa/add_stdin_lock
Locking for stdin
5 years ago
k-nasa 3dcad984b4 fix: To unstable feature 5 years ago
Yoshua Wuyts c413e717da
Merge pull request #429 from markhildreth/tcp_smoke_tests
Added TCP smoke tests against std Listener and Stream
5 years ago
Yoshua Wuyts 911ebada0b
Merge pull request #434 from paulocsanz/master
Put everything behind a 'stable' feature to avoid future breaking changes
5 years ago
Aleksey Kladov ec1a6ea3e8 Fix typo (#439) 5 years ago
Tyler Neely 5adc608791 Spawn several threads when we fail to enqueue work in the blocki… (#181)
* Rebase onto master

* Switch to unbounded channels
5 years ago
Sheyne Anderson 1a51ca424a Fix typo in tutorial in book (#412) 5 years ago
k-nasa 81873ae5f3 fix 5 years ago
Florian Gilcher d5fd035956 Small example for a TCP server that both handles IP v4 and v6 (#418)
* Add a small example for listening to both ipv4 and ipv6

Presenting stream merge on Incoming.

* Change stable checks workflow to not cover examples, but tests
5 years ago
Yoshua Wuyts e17a6703c8
Merge pull request #415 from k-nasa/stream_from_iter
Add stream::from_iter
5 years ago
Paulo 8e991bcd3a Fix typo 5 years ago
Paulo 2e66c38453 Simplify default feature 5 years ago
k-nasa 0661f774c2 Merge branch 'master' into add_stdin_lock 5 years ago
k-nasa 2f3c867d44 Merge branch 'master' into stream_from_iter 5 years ago
k-nasa 063798ce49 Add doc 5 years ago
Yoshua Wuyts a3b742188d fix doc tests (#431)
* fix doc tests

Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>

* cargo fmt

Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>
5 years ago
Florian Gilcher 57670dd9d7
Merge pull request #433 from JohnTitor/remove-deprecated-action
Remove deprecated action
5 years ago
Paulo dcd7c55cef Put everything behind a 'stable' feature 5 years ago
Yuki Okushi 277fd521bc Remove deprecated action 5 years ago
Stjepan Glavina 87de4e1598
Add utility type WakerSet to the sync module (#390)
* Add utility type Registry to the sync module

* Remove unused import

* Split unregister into complete and cancel

* Refactoring and renaming

* Split remove() into complete() and cancel()

* Rename to WakerSet

* Ignore clippy warning

* Ignore another clippy warning

* Use stronger SeqCst ordering
5 years ago
Stjepan Glavina 3dd59d7056
Refactor the task module (#421)
* Refactor the task module

* Fix clippy warning

* Simplify task-local entries

* Reduce the amount of future wrapping

* Cleanup

* Simplify stealing
5 years ago
k-nasa caa23381f0 fix clippy warning 5 years ago
k-nasa eeb44c86e9 fix 5 years ago
k-nasa f8b8c9debe Merge branch 'master' into add_stdin_lock 5 years ago
Yoshua Wuyts c1e8517959
Merge pull request #414 from k-nasa/fix_github_actions
Add only rustfmt on Checking fmt and docs actions
5 years ago
Yoshua Wuyts cc75b65b8c
Merge pull request #409 from yjhmelody/stream-min
Add Stream min
5 years ago
Yoshua Wuyts f102588df5
Merge pull request #428 from zhangguyu6/stream-position
Add stream position
5 years ago
Yoshua Wuyts 3e0fe742f6
Merge pull request #427 from yjhmelody/stream-ne
Add stream ne
5 years ago
Yoshua Wuyts 65dcaf4464
Merge pull request #426 from yjhmelody/stream-eq
Add stream eq
5 years ago
zhangguyu 07d21e5eb3 change trait bounds 5 years ago
Mark Hildreth c6c2bfa456 Added TCP smoke tests against std Listener and Stream 5 years ago
zhangguyu 48c82a9668 Add stream position 5 years ago
yjhmelody 1ab3d901e4 fmt code 5 years ago
yjhmelody 204da33391 fmt code 5 years ago
yjhmelody 17db7ffcd3 Add stream ne 5 years ago
yjhmelody f5efaaa7ba Add stream eq 5 years ago
Yoshua Wuyts cc949f48ea
Merge pull request #420 from JayatiGoyal/master
correction of a typo
5 years ago
JayatiGoyal 5fee91c050
corrected a typo 5 years ago
k-nasa 40c4e1a29d feat: Add stream::from_iter 5 years ago
k-nasa 3620b2b6ab fix: Add only rustfmt on Checking fmt and docs actions 5 years ago
k-nasa 2c91b30ee8 feat: Add Read and Write trait to Lock struct 5 years ago
yjhmelody 021862dcc8 fix min 5 years ago
yjhmelody b942d0a405 add stream-min 5 years ago
k-nasa 35cb11e398 Merge branch 'master' into add_stdin_lock 5 years ago
k-nasa 59615a655b feat: Add StderrLock and StdoutLock struct 5 years ago
Johannes Weissmann 75546ef831 Merge branch 'master' into stream_count 5 years ago
Johannes Weissmann 6608d39c59 remove Stream trait bound 5 years ago
k-nasa 48b255897e Merge branch 'master' into add_stdin_lock 5 years ago
Wouter Geraedts 1fd05a157f Reset delay to prevent poll after ready 5 years ago
Wouter Geraedts 1c843a8124 Re-implemented Throttle to keep last value in memory 5 years ago
Johannes Weissmann 97094b2a1c remove Sized constraint 5 years ago
Wouter Geraedts ced5281b73 Merge remote-tracking branch 'upstream/master' into 342-stream-throttle 5 years ago
Johannes Weissmann a9a7bdc290 add stream::count 5 years ago
k-nasa f2bf01223c $cargo fmt 5 years ago
k-nasa 70e8476264 fix StdinLock doc test 5 years ago
k-nasa a5a00d7b14 feat: Add StdinLock struct 5 years ago
Wouter Geraedts a2393501c5 Implemented StreamExt::throttle 5 years ago
k-nasa 94ef3dc2b2 feat: Add Stdout::lock 5 years ago
k-nasa 9b09806593 feat: Add Stdin::lock 5 years ago
k-nasa f9741e7488 feat: Add Stderr::lock 5 years ago
Yoshua Wuyts 483ded0e1c
fix example
Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>
5 years ago
Yoshua Wuyts 064fdf020f
Stream::delay
Signed-off-by: Yoshua Wuyts <yoshuawuyts@gmail.com>
5 years ago

@ -0,0 +1,3 @@
Our contribution policy can be found at [async.rs/contribute][policy].
[policy]: https://async.rs/contribute/

@ -4,6 +4,7 @@ on:
pull_request: pull_request:
push: push:
branches: branches:
- master
- staging - staging
- trying - trying
@ -17,7 +18,7 @@ jobs:
strategy: strategy:
matrix: matrix:
os: [ubuntu-latest, windows-latest, macOS-latest] os: [ubuntu-latest, windows-latest, macOS-latest]
rust: [nightly] rust: [nightly, beta, stable]
steps: steps:
- uses: actions/checkout@master - uses: actions/checkout@master
@ -28,39 +29,143 @@ jobs:
toolchain: ${{ matrix.rust }} toolchain: ${{ matrix.rust }}
override: true override: true
- name: Cache cargo registry
uses: actions/cache@v2
with:
path: ~/.cargo/registry
key: ${{ matrix.os }}-${{ matrix.rust }}-cargo-registry-${{ hashFiles('**/Cargo.toml') }}
- name: Cache cargo index
uses: actions/cache@v2
with:
path: ~/.cargo/git
key: ${{ matrix.os }}-${{ matrix.rust }}-cargo-index-${{ hashFiles('**/Cargo.toml') }}
- name: Cache cargo build
uses: actions/cache@v2
with:
path: target
key: ${{ matrix.os }}-${{ matrix.rust }}-cargo-build-target-${{ hashFiles('**/Cargo.toml') }}
- name: check - name: check
uses: actions-rs/cargo@v1 uses: actions-rs/cargo@v1
with: with:
command: check command: check
args: --all --bins --examples args: --all --bins --tests
- name: check unstable - name: check unstable
uses: actions-rs/cargo@v1 uses: actions-rs/cargo@v1
with: with:
command: check command: check
args: --features unstable --all --benches --bins --examples --tests args: --features unstable --all --bins --examples --tests
- name: check wasm
uses: actions-rs/cargo@v1
with:
command: check
target: wasm32-unknown-unknown
override: true
args: --features unstable --all --bins --tests
- name: check bench
uses: actions-rs/cargo@v1
if: matrix.rust == 'nightly'
with:
command: check
args: --benches
- name: check std only
uses: actions-rs/cargo@v1
with:
command: check
args: --no-default-features --features std
- name: check attributes
uses: actions-rs/cargo@v1
with:
command: check
args: --features attributes
- name: tests - name: tests
uses: actions-rs/cargo@v1 uses: actions-rs/cargo@v1
with: with:
command: test command: test
args: --all --features unstable args: --all --features "unstable attributes"
check_fmt_and_docs: build__with_no_std:
name: Checking fmt and docs name: Build with no-std
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- name: setup
run: |
rustup default nightly
rustup target add thumbv7m-none-eabi
- name: check no_std
uses: actions-rs/cargo@v1
with:
command: check
args: --no-default-features --features alloc --target thumbv7m-none-eabi -Z avoid-dev-deps
check_tokio_02_feature:
name: Check tokio02 feature
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- name: check tokio02
uses: actions-rs/cargo@v1
with:
command: check
args: --all --features tokio02
cross:
name: Cross compile
runs-on: ubuntu-latest runs-on: ubuntu-latest
strategy:
matrix:
target:
- i686-unknown-linux-gnu
- powerpc-unknown-linux-gnu
- powerpc64-unknown-linux-gnu
- mips-unknown-linux-gnu
- arm-linux-androideabi
steps: steps:
- uses: actions/checkout@master - uses: actions/checkout@master
- id: component - name: Install nightly
uses: actions-rs/components-nightly@v1 uses: actions-rs/toolchain@v1
with: with:
component: rustfmt toolchain: nightly
override: true
- name: Install cross
run: cargo install cross
- name: check
run: cross check --all --target ${{ matrix.target }}
- name: check unstable
run: cross check --all --features unstable --target ${{ matrix.target }}
- name: test
run: cross test --all --features unstable --target ${{ matrix.target }}
check_fmt_and_docs:
name: Checking fmt and docs
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- uses: actions-rs/toolchain@v1 - uses: actions-rs/toolchain@v1
with: with:
toolchain: ${{ steps.component.outputs.toolchain }} profile: minimal
toolchain: nightly
override: true override: true
components: rustfmt
- name: setup - name: setup
run: | run: |
@ -76,15 +181,3 @@ jobs:
- name: Docs - name: Docs
run: cargo doc --features docs run: cargo doc --features docs
clippy_check:
name: Clippy check
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- name: Install rust
run: rustup update beta && rustup default beta
- name: Install clippy
run: rustup component add clippy
- name: clippy
run: cargo clippy --all --features unstable

@ -7,6 +7,414 @@ and this project adheres to [Semantic Versioning](https://book.async.rs/overview
## [Unreleased] ## [Unreleased]
# [1.6.2] - 2020-06-19
## Added
- Add `UdpSocket::peer_addr` ([#816](https://github.com/async-rs/async-std/pull/816))
## Changed
## Fixed
- Ensure the reactor is running for sockets and timers ([#819](https://github.com/async-rs/async-std/pull/819)).
- Avoid excessive polling in `flatten` and `flat_map` ([#701](https://github.com/async-rs/async-std/pull/701))
# [1.6.1] - 2020-06-11
## Added
- Added `tokio02` feature flag, to allow compatability usage with tokio@0.2 ([#804](https://github.com/async-rs/async-std/pull/804)).
## Changed
- Removed unstable `stdio` lock methods, due to their unsoundness ([#807](https://github.com/async-rs/async-std/pull/807)).
## Fixed
- Fixed wrong slice index for file reading ([#802](https://github.com/async-rs/async-std/pull/802)).
- Fixed recursive calls to `block_on` ([#799](https://github.com/async-rs/async-std/pull/799)) and ([#809](https://github.com/async-rs/async-std/pull/809)).
- Remove `default` feature requirement for the `unstable` feature ([#806](https://github.com/async-rs/async-std/pull/806)).
# [1.6.0] - 2020-05-22
See `1.6.0-beta.1` and `1.6.0-beta.2`.
# [1.6.0-beta.2] - 2020-05-19
## Added
- Added an environment variable to configure the thread pool size of the runtime. ([#774](https://github.com/async-rs/async-std/pull/774))
- Implement `Clone` for `UnixStream` ([#772](https://github.com/async-rs/async-std/pull/772))
## Changed
- For `wasm`, switched underlying `Timer` implementation to [`futures-timer`](https://github.com/async-rs/futures-timer). ([#776](https://github.com/async-rs/async-std/pull/776))
## Fixed
- Use `smol::block_on` to handle drop of `File`, avoiding nested executor panic. ([#768](https://github.com/async-rs/async-std/pull/768))
# [1.6.0-beta.1] - 2020-05-07
## Added
- Added `task::spawn_local`. ([#757](https://github.com/async-rs/async-std/pull/757))
- Added out of the box support for `wasm`. ([#757](https://github.com/async-rs/async-std/pull/757))
- Added `JoinHandle::cancel` ([#757](https://github.com/async-rs/async-std/pull/757))
- Added `sync::Condvar` ([#369](https://github.com/async-rs/async-std/pull/369))
- Added `sync::Sender::try_send` and `sync::Receiver::try_recv` ([#585](https://github.com/async-rs/async-std/pull/585))
- Added `no_std` support for `task`, `future` and `stream` ([#680](https://github.com/async-rs/async-std/pull/680))
## Changed
- Switched underlying runtime to [`smol`](https://github.com/stjepang/smol/). ([#757](https://github.com/async-rs/async-std/pull/757))
- Switched implementation of `sync::Barrier` to use `sync::Condvar` like `std` does. ([#581](https://github.com/async-rs/async-std/pull/581))
## Fixed
- Allow compilation on 32 bit targets, by using `AtomicUsize` for `TaskId`. ([#756](https://github.com/async-rs/async-std/pull/756))
# [1.5.0] - 2020-02-03
[API Documentation](https://docs.rs/async-std/1.5.0/async-std)
This patch includes various quality of life improvements to async-std.
Including improved performance, stability, and the addition of various
`Clone` impls that replace the use of `Arc` in many cases.
## Added
- Added links to various ecosystem projects from the README ([#660](https://github.com/async-rs/async-std/pull/660))
- Added an example on `FromStream` for `Result<T, E>` ([#643](https://github.com/async-rs/async-std/pull/643))
- Added `stream::pending` as "unstable" ([#615](https://github.com/async-rs/async-std/pull/615))
- Added an example of `stream::timeout` to document the error flow ([#675](https://github.com/async-rs/async-std/pull/675))
- Implement `Clone` for `DirEntry` ([#682](https://github.com/async-rs/async-std/pull/682))
- Implement `Clone` for `TcpStream` ([#689](https://github.com/async-rs/async-std/pull/689))
## Changed
- Removed internal comment on `stream::Interval` ([#645](https://github.com/async-rs/async-std/pull/645))
- The "unstable" feature can now be used without requiring the "default" feature ([#647](https://github.com/async-rs/async-std/pull/647))
- Removed unnecessary trait bound on `stream::FlatMap` ([#651](https://github.com/async-rs/async-std/pull/651))
- Updated the "broadcaster" dependency used by "unstable" to `1.0.0` ([#681](https://github.com/async-rs/async-std/pull/681))
- Updated `async-task` to 1.2.1 ([#676](https://github.com/async-rs/async-std/pull/676))
- `task::block_on` now parks after a single poll, improving performance in many cases ([#684](https://github.com/async-rs/async-std/pull/684))
- Improved reading flow of the "client" part of the async-std tutorial ([#550](https://github.com/async-rs/async-std/pull/550))
- Use `take_while` instead of `scan` in `impl` of `Product`, `Sum` and `FromStream` ([#667](https://github.com/async-rs/async-std/pull/667))
- `TcpStream::connect` no longer uses a thread from the threadpool, improving performance ([#687](https://github.com/async-rs/async-std/pull/687))
## Fixed
- Fixed crate documentation typo ([#655](https://github.com/async-rs/async-std/pull/655))
- Fixed documentation for `UdpSocket::recv` ([#648](https://github.com/async-rs/async-std/pull/648))
- Fixed documentation for `UdpSocket::send` ([#671](https://github.com/async-rs/async-std/pull/671))
- Fixed typo in stream documentation ([#650](https://github.com/async-rs/async-std/pull/650))
- Fixed typo on `sync::JoinHandle` documentation ([#659](https://github.com/async-rs/async-std/pull/659))
- Removed use of `std::error::Error::description` which failed CI ([#661](https://github.com/async-rs/async-std/pull/662))
- Removed the use of rustfmt's unstable `format_code_in_doc_comments` option which failed CI ([#685](https://github.com/async-rs/async-std/pull/685))
- Fixed a code typo in the `task::sleep` example ([#688](https://github.com/async-rs/async-std/pull/688))
# [1.4.0] - 2019-12-20
[API Documentation](https://docs.rs/async-std/1.4.0/async-std)
This patch adds `Future::timeout`, providing a method counterpart to the
`future::timeout` free function. And includes several bug fixes around missing
APIs. Notably we're not shipping our new executor yet, first announced [on our
blog](https://async.rs/blog/stop-worrying-about-blocking-the-new-async-std-runtime/).
## Examples
```rust
use async_std::prelude::*;
use async_std::future;
use std::time::Duration;
let fut = future::pending::<()>(); // This future will never resolve.
let res = fut.timeout(Duration::from_millis(100)).await;
assert!(res.is_err()); // The future timed out, returning an err.
```
## Added
- Added `Future::timeout` as "unstable" [(#600)](https://github.com/async-rs/async-std/pull/600)
## Fixes
- Fixed a doc test and enabled it on CI [(#597)](https://github.com/async-rs/async-std/pull/597)
- Fixed a rendering issue with the `stream` submodule documentation [(#621)](https://github.com/async-rs/async-std/pull/621)
- `Write::write_fmt`'s future is now correctly marked as `#[must_use]` [(#628)](https://github.com/async-rs/async-std/pull/628)
- Fixed the missing `io::Bytes` export [(#633)](https://github.com/async-rs/async-std/pull/633)
- Fixed the missing `io::Chain` export [(#633)](https://github.com/async-rs/async-std/pull/633)
- Fixed the missing `io::Take` export [(#633)](https://github.com/async-rs/async-std/pull/633)
# [1.3.0] - 2019-12-12
[API Documentation](https://docs.rs/async-std/1.3.0/async-std)
This patch introduces `Stream::delay`, more methods on `DoubleEndedStream`,
and improves compile times. `Stream::delay` is a new API that's similar to
[`task::sleep`](https://docs.rs/async-std/1.2.0/async_std/task/fn.sleep.html),
but can be passed as part of as stream, rather than as a separate block. This is
useful for examples, or when manually debugging race conditions.
## Examples
```rust
let start = Instant::now();
let mut s = stream::from_iter(vec![0u8, 1]).delay(Duration::from_millis(200));
// The first time will take more than 200ms due to delay.
s.next().await;
assert!(start.elapsed().as_millis() >= 200);
// There will be no delay after the first time.
s.next().await;
assert!(start.elapsed().as_millis() <= 210);
```
## Added
- Added `Stream::delay` as "unstable" [(#309)](https://github.com/async-rs/async-std/pull/309)
- Added `DoubleEndedStream::next_back` as "unstable" [(#562)](https://github.com/async-rs/async-std/pull/562)
- Added `DoubleEndedStream::nth_back` as "unstable" [(#562)](https://github.com/async-rs/async-std/pull/562)
- Added `DoubleEndedStream::rfind` as "unstable" [(#562)](https://github.com/async-rs/async-std/pull/562)
- Added `DoubleEndedStream::rfold` as "unstable" [(#562)](https://github.com/async-rs/async-std/pull/562)
- Added `DoubleEndedStream::try_rfold` as "unstable" [(#562)](https://github.com/async-rs/async-std/pull/562)
- `stream::Once` now implements `DoubleEndedStream` [(#562)](https://github.com/async-rs/async-std/pull/562)
- `stream::FromIter` now implements `DoubleEndedStream` [(#562)](https://github.com/async-rs/async-std/pull/562)
## Changed
- Removed our dependency on `async-macros`, speeding up compilation [(#610)](https://github.com/async-rs/async-std/pull/610)
## Fixes
- Fixed a link in the task docs [(#598)](https://github.com/async-rs/async-std/pull/598)
- Fixed the `UdpSocket::recv` example [(#603)](https://github.com/async-rs/async-std/pull/603)
- Fixed a link to `task::block_on` [(#608)](https://github.com/async-rs/async-std/pull/608)
- Fixed an incorrect API mention in `task::Builder` [(#612)](https://github.com/async-rs/async-std/pull/612)
- Fixed leftover mentions of `futures-preview` [(#595)](https://github.com/async-rs/async-std/pull/595)
- Fixed a typo in the tutorial [(#614)](https://github.com/async-rs/async-std/pull/614)
- `<TcpStream as Write>::poll_close` now closes the write half of the stream [(#618)](https://github.com/async-rs/async-std/pull/618)
# [1.2.0] - 2019-11-27
[API Documentation](https://docs.rs/async-std/1.2.0/async-std)
This patch includes some minor quality-of-life improvements, introduces a
new `Stream::unzip` API, and adds verbose errors to our networking types.
This means if you can't connect to a socket, you'll never have to wonder again
*which* address it was you couldn't connect to, instead of having to go through
the motions to debug what the address was.
## Example
Unzip a stream of tuples into two collections:
```rust
use async_std::prelude::*;
use async_std::stream;
let s = stream::from_iter(vec![(1,2), (3,4)]);
let (left, right): (Vec<_>, Vec<_>) = s.unzip().await;
assert_eq!(left, [1, 3]);
assert_eq!(right, [2, 4]);
```
## Added
- Added `Stream::unzip` as "unstable".
- Added verbose errors to the networking types.
## Changed
- Enabled CI on master branch.
- `Future::join` and `Future::try_join` can now join futures with different
output types.
## Fixed
- Fixed the docs and `Debug` output of `BufWriter`.
- Fixed a bug in `Stream::throttle` that made it consume too much CPU.
# [1.1.0] - 2019-11-21
[API Documentation](https://docs.rs/async-std/1.1.0/async-std)
This patch introduces a faster scheduler algorithm, `Stream::throttle`, and
stabilizes `task::yield_now`. Additionally we're introducing several more stream
APIs, bringing us to almost complete parity with the standard library.
Furthermore our `path` submodule now returns more context in errors. So if
opening a file fails, async-std will tell you *which* file was failed to open,
making it easier to write and debug programs.
## Examples
```rust
let start = Instant::now();
let mut s = stream::interval(Duration::from_millis(5))
.throttle(Duration::from_millis(10))
.take(2);
s.next().await;
assert!(start.elapsed().as_millis() >= 5);
s.next().await;
assert!(start.elapsed().as_millis() >= 15);
s.next().await;
assert!(start.elapsed().as_millis() >= 25);
```
## Added
- Added `Stream::throttle` as "unstable".
- Added `Stream::count` as "unstable".
- Added `Stream::max` as "unstable".
- Added `Stream::successors` as "unstable".
- Added `Stream::by_ref` as "unstable".
- Added `Stream::partition` as "unstable".
- Added contextual errors to the `path` submodule.
- Added `os::windows::symlink_dir` as "unstable".
- Added `os::windows::symlink_file` as "unstable".
- Stabilized `task::yield_now`.
## Fixes
- We now ignore seek errors when rolling back failed `read` calls on `File`.
- Fixed a bug where `Stream::max_by_key` was returning the wrong result.
- Fixed a bug where `Stream::min_by_key` was returning the wrong result.
## Changed
- Applied various fixes to the tutorial.
- Fixed an issue with Clippy.
- Optimized an internal code generation macro, improving compilation speeds.
- Removed an `Unpin` bound from `stream::Once`.
- Removed various extra internal uses of `pin_mut!`.
- Simplified `Stream::any` and `Stream::all`'s internals.
- The `surf` example is now enabled again.
- Tweaked some streams internals.
- Updated `futures-timer` to 2.0.0, improving compilation speed.
- Upgraded `async-macros` to 2.0.0.
- `Stream::merge` now uses randomized ordering to reduce overall latency.
- The scheduler is now more efficient by keeping a slot for the next task to
run. This is similar to Go's scheduler, and Tokio's scheduler.
- Fixed the documentation of the `channel` types to link back to the `channel`
function.
# [1.0.1] - 2019-11-12
[API Documentation](https://docs.rs/async-std/1.0.1/async-std)
We were seeing a regression in our fs performance, caused by too many
long-running tasks. This patch fixes that regression by being more proactive
about closing down idle threads.
## Changes
- Improved thread startup/shutdown algorithm in `task::spawn_blocking`.
- Fixed a typo in the tutorial.
# [1.0.0] - 2019-11-11
[API Documentation](https://docs.rs/async-std/1.0.0/async-std)
This release marks the `1.0.0` release of async-std; a major milestone for our
development. This release itself mostly includes quality of life improvements
for all of modules, including more consistent API bounds for a lot of our
submodules.
The biggest change is that we're now using the full semver range,
`major.minor.patch`, and any breaking changes to our "stable" APIs will require
an update of the `major` number.
We're excited we've hit this milestone together with you all. Thank you!
## Added
- Added `Future::join` as "unstable", replacing `future::join!`.
- Added `Future::try_join` as "unstable", replacing `future::try_join!`.
- Enabled `stable` and `beta` channel testing on CI.
- Implemented `FromIterator` and `Extend` for `PathBuf`.
- Implemented `FromStream` for `PathBuf`.
- Loosened the trait bounds of `io::copy` on "unstable".
## Changed
- Added a `Sync` bound to `RwLock`, resolving a memory safety issue.
- Fixed a bug in `Stream::take_while` where it could continue after it should've
ended.
- Fixed a bug where our `attributes` Cargo feature wasn't working as intended.
- Improved documentation of `Stream::merge`, documenting ordering guarantees.
- Update doc imports in examples to prefer async-std's types.
- Various quality of life improvements to the `future` submodule.
- Various quality of life improvements to the `path` submodule.
- Various quality of life improvements to the `stream` submodule.
## Removed
- Removed `future::join!` in favor of `Future::join`.
- Removed `future::try_join!` in favor of `Future::try_join`.
# [0.99.12] - 2019-11-07
[API Documentation](https://docs.rs/async-std/0.99.12/async-std)
This patch upgrades us to `futures` 0.3, support for `async/await` on Rust
Stable, performance improvements, and brand new module-level documentation.
## Added
- Added `Future::flatten` as "unstable".
- Added `Future::race` as "unstable" (replaces `future::select!`).
- Added `Future::try_race` as "unstable" (replaces `future::try_select!`).
- Added `Stderr::lock` as "unstable".
- Added `Stdin::lock` as "unstable".
- Added `Stdout::lock` as "unstable".
- Added `Stream::copied` as "unstable".
- Added `Stream::eq` as "unstable".
- Added `Stream::max_by_key` as "unstable".
- Added `Stream::min` as "unstable".
- Added `Stream::ne` as "unstable".
- Added `Stream::position` as "unstable".
- Added `StreamExt` and `FutureExt` as enumerable in the `prelude`.
- Added `TcpListener` and `TcpStream` integration tests.
- Added `stream::from_iter`.
- Added `sync::WakerSet` for internal use.
- Added an example to handle both `IP v4` and `IP v6` connections.
- Added the `default` Cargo feature.
- Added the `attributes` Cargo feature.
- Added the `std` Cargo feature.
## Changed
- Fixed a bug in the blocking threadpool where it didn't spawn more than one thread.
- Fixed a bug with `Stream::merge` where sometimes it ended too soon.
- Fixed a bug with our GitHub actions setup.
- Fixed an issue where our channels could spuriously deadlock.
- Refactored the `task` module.
- Removed a deprecated GitHub action.
- Replaced `futures-preview` with `futures`.
- Replaced `lazy_static` with `once_cell`.
- Replaced all uses of `VecDequeue` in the examples with `stream::from_iter`.
- Simplified `sync::RwLock` using the internal `sync::WakerSet` type.
- Updated the `path` submodule documentation to match std.
- Updated the mod-level documentation to match std.
## Removed
- Removed `future::select!` (replaced by `Future::race`).
- Removed `future::try_select!` (replaced by `Future::try_race`).
# [0.99.11] - 2019-10-29 # [0.99.11] - 2019-10-29
This patch introduces `async_std::sync::channel`, a novel asynchronous port of This patch introduces `async_std::sync::channel`, a novel asynchronous port of
@ -338,8 +746,21 @@ task::blocking(async {
- Initial beta release - Initial beta release
[Unreleased]: https://github.com/async-rs/async-std/compare/v0.99.11...HEAD [Unreleased]: https://github.com/async-rs/async-std/compare/v1.6.2...HEAD
[0.99.10]: https://github.com/async-rs/async-std/compare/v0.99.10...v0.99.11 [1.6.2]: https://github.com/async-rs/async-std/compare/v1.6.1...v1.6.2
[1.6.1]: https://github.com/async-rs/async-std/compare/v1.6.0...v1.6.1
[1.6.0]: https://github.com/async-rs/async-std/compare/v1.5.0...v1.6.0
[1.6.0-beta.2]: https://github.com/async-rs/async-std/compare/v1.6.0-beta.1...v1.6.0-beta.2
[1.6.0-beta.1]: https://github.com/async-rs/async-std/compare/v1.5.0...v1.6.0-beta.1
[1.5.0]: https://github.com/async-rs/async-std/compare/v1.4.0...v1.5.0
[1.4.0]: https://github.com/async-rs/async-std/compare/v1.3.0...v1.4.0
[1.3.0]: https://github.com/async-rs/async-std/compare/v1.2.0...v1.3.0
[1.2.0]: https://github.com/async-rs/async-std/compare/v1.1.0...v1.2.0
[1.1.0]: https://github.com/async-rs/async-std/compare/v1.0.1...v1.1.0
[1.0.1]: https://github.com/async-rs/async-std/compare/v1.0.0...v1.0.1
[1.0.0]: https://github.com/async-rs/async-std/compare/v0.99.12...v1.0.0
[0.99.12]: https://github.com/async-rs/async-std/compare/v0.99.11...v0.99.12
[0.99.11]: https://github.com/async-rs/async-std/compare/v0.99.10...v0.99.11
[0.99.10]: https://github.com/async-rs/async-std/compare/v0.99.9...v0.99.10 [0.99.10]: https://github.com/async-rs/async-std/compare/v0.99.9...v0.99.10
[0.99.9]: https://github.com/async-rs/async-std/compare/v0.99.8...v0.99.9 [0.99.9]: https://github.com/async-rs/async-std/compare/v0.99.8...v0.99.9
[0.99.8]: https://github.com/async-rs/async-std/compare/v0.99.7...v0.99.8 [0.99.8]: https://github.com/async-rs/async-std/compare/v0.99.7...v0.99.8

@ -1,9 +1,10 @@
[package] [package]
name = "async-std" name = "async-std"
version = "0.99.11" version = "1.6.2"
authors = [ authors = [
"Stjepan Glavina <stjepang@gmail.com>", "Stjepan Glavina <stjepang@gmail.com>",
"Yoshua Wuyts <yoshuawuyts@gmail.com>", "Yoshua Wuyts <yoshuawuyts@gmail.com>",
"Friedel Ziegelmayer <me@dignifiedquire.com>",
"Contributors to async-std", "Contributors to async-std",
] ]
edition = "2018" edition = "2018"
@ -21,36 +22,86 @@ features = ["docs"]
rustdoc-args = ["--cfg", "feature=\"docs\""] rustdoc-args = ["--cfg", "feature=\"docs\""]
[features] [features]
docs = ["unstable"] default = [
unstable = ["broadcaster"] "std",
"async-task",
"kv-log-macro",
"log",
"num_cpus",
"pin-project-lite",
"smol",
]
docs = ["attributes", "unstable", "default"]
unstable = [
"std",
"futures-timer",
]
attributes = ["async-attributes"]
std = [
"alloc",
"crossbeam-utils",
"futures-core/std",
"futures-io",
"memchr",
"once_cell",
"pin-utils",
"slab",
"wasm-bindgen-futures",
"futures-channel",
"async-mutex",
]
alloc = [
"futures-core/alloc",
"pin-project-lite",
]
tokio02 = ["smol/tokio02"]
[dependencies] [dependencies]
async-macros = "1.0.0" async-attributes = { version = "1.1.1", optional = true }
async-task = "1.0.0" async-task = { version = "3.0.0", optional = true }
crossbeam-channel = "0.3.9" async-mutex = { version = "1.1.3", optional = true }
crossbeam-deque = "0.7.1" crossbeam-utils = { version = "0.7.2", optional = true }
crossbeam-utils = "0.6.6" futures-core = { version = "0.3.4", optional = true, default-features = false }
futures-core-preview = "=0.3.0-alpha.19" futures-io = { version = "0.3.4", optional = true }
futures-io-preview = "=0.3.0-alpha.19" kv-log-macro = { version = "1.0.6", optional = true }
futures-timer = "1.0.2" log = { version = "0.4.8", features = ["kv_unstable"], optional = true }
log = { version = "0.4.8", features = ["kv_unstable"] } memchr = { version = "2.3.3", optional = true }
memchr = "2.2.1" num_cpus = { version = "1.12.0", optional = true }
mio = "0.6.19" once_cell = { version = "1.3.1", optional = true }
mio-uds = "0.6.7" pin-project-lite = { version = "0.1.4", optional = true }
num_cpus = "1.10.1" pin-utils = { version = "0.1.0-alpha.4", optional = true }
once_cell = "1.2.0" slab = { version = "0.4.2", optional = true }
slab = "0.4.2" futures-timer = { version = "3.0.2", optional = true }
kv-log-macro = "1.0.4"
broadcaster = { version = "0.2.6", optional = true, default-features = false, features = ["default-channels"] } # Devdepencency, but they are not allowed to be optional :/
pin-project-lite = "0.1" surf = { version = "1.0.3", optional = true }
[target.'cfg(not(target_os = "unknown"))'.dependencies]
smol = { version = "0.1.17", optional = true }
[target.'cfg(target_arch = "wasm32")'.dependencies]
futures-timer = { version = "3.0.2", optional = true, features = ["wasm-bindgen"] }
wasm-bindgen-futures = { version = "0.4.10", optional = true }
futures-channel = { version = "0.3.4", optional = true }
[target.'cfg(target_arch = "wasm32")'.dev-dependencies]
wasm-bindgen-test = "0.3.10"
[dev-dependencies] [dev-dependencies]
femme = "1.2.0" femme = "1.3.0"
rand = "0.7.2" rand = "0.7.3"
# surf = "1.0.2"
tempdir = "0.3.7" tempdir = "0.3.7"
futures-preview = { version = "=0.3.0-alpha.19", features = ["async-await"] } futures = "0.3.4"
rand_xorshift = "0.2.0"
[[test]]
name = "stream"
required-features = ["unstable"]
[[example]]
name = "tcp-ipv4-and-6-echo"
required-features = ["unstable"]
# These are used by the book for examples [[example]]
futures-channel-preview = "=0.3.0-alpha.19" name = "surf-web"
futures-util-preview = "=0.3.0-alpha.19" required-features = ["surf"]

@ -8,6 +8,11 @@
<br /> <br />
<div align="center"> <div align="center">
<!-- CI status -->
<a href="https://github.com/async-rs/async-std/actions">
<img src="https://github.com/async-rs/async-std/workflows/CI/badge.svg"
alt="CI Status" />
</a>
<!-- Crates version --> <!-- Crates version -->
<a href="https://crates.io/crates/async-std"> <a href="https://crates.io/crates/async-std">
<img src="https://img.shields.io/crates/v/async-std.svg?style=flat-square" <img src="https://img.shields.io/crates/v/async-std.svg?style=flat-square"
@ -61,7 +66,7 @@ syntax.
## Features ## Features
- __Modern:__ Built from the ground up for `std::future` and `async/await` with - __Modern:__ Built from the ground up for `std::future` and `async/await` with
blazing fast compilation times. blazing fast compilation time.
- __Fast:__ Our robust allocator and threadpool designs provide ultra-high - __Fast:__ Our robust allocator and threadpool designs provide ultra-high
throughput with predictably low latency. throughput with predictably low latency.
- __Intuitive:__ Complete parity with the stdlib means you only need to learn - __Intuitive:__ Complete parity with the stdlib means you only need to learn
@ -77,17 +82,22 @@ syntax.
```rust ```rust
use async_std::task; use async_std::task;
async fn say_hello() {
println!("Hello, world!");
}
fn main() { fn main() {
task::block_on(async { task::block_on(say_hello())
println!("Hello, world!");
})
} }
``` ```
More examples, including networking and file access, can be found in our More examples, including networking and file access, can be found in our
[`examples`] directory. [`examples`] directory and in our [documentation].
[`examples`]: https://github.com/async-rs/async-std/tree/master/examples [`examples`]: https://github.com/async-rs/async-std/tree/master/examples
[documentation]: https://docs.rs/async-std#examples
[`task::block_on`]: https://docs.rs/async-std/*/async_std/task/fn.block_on.html
[`"attributes"` feature]: https://docs.rs/async-std/#features
## Philosophy ## Philosophy
@ -115,6 +125,24 @@ documentation] on how to enable them.
[cargo-add]: https://github.com/killercup/cargo-edit [cargo-add]: https://github.com/killercup/cargo-edit
[features documentation]: https://docs.rs/async-std/#features [features documentation]: https://docs.rs/async-std/#features
## Ecosystem
* [async-tls](https://crates.io/crates/async-tls) — Async TLS/SSL streams using **Rustls**.
* [async-native-tls](https://crates.io/crates/async-native-tls) — **Native TLS** for Async. Native TLS for futures and async-std.
* [async-tungstenite](https://crates.io/crates/async-tungstenite) — Asynchronous **WebSockets** for async-std, tokio, gio and any std Futures runtime.
* [Tide](https://crates.io/crates/tide) — Serve the web. A modular **web framework** built around async/await.
* [SQLx](https://crates.io/crates/sqlx) — The Rust **SQL** Toolkit. SQLx is a 100% safe Rust library for Postgres and MySQL with compile-time checked queries.
* [Surf](https://crates.io/crates/surf) — Surf the web. Surf is a friendly **HTTP client** built for casual Rustaceans and veterans alike.
* [Xactor](https://crates.io/crates/xactor) — Xactor is a rust actors framework based on async-std.
* [async-graphql](https://crates.io/crates/async-graphql) — A GraphQL server library implemented in rust, with full support for async/await.
## License ## License
<sup> <sup>

@ -0,0 +1,40 @@
#![feature(test)]
extern crate test;
use async_std::sync::{Arc, Mutex};
use async_std::task;
use test::Bencher;
#[bench]
fn create(b: &mut Bencher) {
b.iter(|| Mutex::new(()));
}
#[bench]
fn contention(b: &mut Bencher) {
b.iter(|| task::block_on(run(10, 1000)));
}
#[bench]
fn no_contention(b: &mut Bencher) {
b.iter(|| task::block_on(run(1, 10000)));
}
async fn run(task: usize, iter: usize) {
let m = Arc::new(Mutex::new(()));
let mut tasks = Vec::new();
for _ in 0..task {
let m = m.clone();
tasks.push(task::spawn(async move {
for _ in 0..iter {
let _ = m.lock().await;
}
}));
}
for t in tasks {
t.await;
}
}

@ -0,0 +1,11 @@
#![feature(test)]
extern crate test;
use async_std::task;
use test::Bencher;
#[bench]
fn block_on(b: &mut Bencher) {
b.iter(|| task::block_on(async {}));
}

@ -19,8 +19,9 @@
- [Clean Shutdown](./tutorial/clean_shutdown.md) - [Clean Shutdown](./tutorial/clean_shutdown.md)
- [Handling Disconnection](./tutorial/handling_disconnection.md) - [Handling Disconnection](./tutorial/handling_disconnection.md)
- [Implementing a Client](./tutorial/implementing_a_client.md) - [Implementing a Client](./tutorial/implementing_a_client.md)
- [TODO: Async Patterns](./patterns.md) - [Async Patterns](./patterns.md)
- [TODO: Collected Small Patterns](./patterns/small-patterns.md) - [TODO: Collected Small Patterns](./patterns/small-patterns.md)
- [Production-Ready Accept Loop](./patterns/accept-loop.md)
- [Security practices](./security/index.md) - [Security practices](./security/index.md)
- [Security Disclosures and Policy](./security/policy.md) - [Security Disclosures and Policy](./security/policy.md)
- [Glossary](./glossary.md) - [Glossary](./glossary.md)

@ -4,13 +4,13 @@ Rust has two kinds of types commonly referred to as `Future`:
- the first is `std::future::Future` from Rusts [standard library](https://doc.rust-lang.org/std/future/trait.Future.html). - the first is `std::future::Future` from Rusts [standard library](https://doc.rust-lang.org/std/future/trait.Future.html).
- the second is `futures::future::Future` from the [futures-rs crate](https://docs.rs/futures-preview/0.3.0-alpha.17/futures/prelude/trait.Future.html), currently released as `futures-preview`. - the second is `futures::future::Future` from the [futures-rs crate](https://docs.rs/futures/0.3/futures/prelude/trait.Future.html).
The future defined in the [futures-rs](https://docs.rs/futures-preview/0.3.0-alpha.17/futures/prelude/trait.Future.html) crate was the original implementation of the type. To enable the `async/await` syntax, the core Future trait was moved into Rusts standard library and became `std::future::Future`. In some sense, the `std::future::Future` can be seen as a minimal subset of `futures::future::Future`. The future defined in the [futures-rs](https://docs.rs/futures/0.3/futures/prelude/trait.Future.html) crate was the original implementation of the type. To enable the `async/await` syntax, the core Future trait was moved into Rusts standard library and became `std::future::Future`. In some sense, the `std::future::Future` can be seen as a minimal subset of `futures::future::Future`.
It is critical to understand the difference between `std::future::Future` and `futures::future::Future`, and the approach that `async-std` takes towards them. In itself, `std::future::Future` is not something you want to interact with as a user—except by calling `.await` on it. The inner workings of `std::future::Future` are mostly of interest to people implementing `Future`. Make no mistake—this is very useful! Most of the functionality that used to be defined on `Future` itself has been moved to an extension trait called [`FuturesExt`](https://docs.rs/futures-preview/0.3.0-alpha.17/futures/future/trait.FutureExt.html). From this information, you might be able to infer that the `futures` library serves as an extension to the core Rust async features. It is critical to understand the difference between `std::future::Future` and `futures::future::Future`, and the approach that `async-std` takes towards them. In itself, `std::future::Future` is not something you want to interact with as a user—except by calling `.await` on it. The inner workings of `std::future::Future` are mostly of interest to people implementing `Future`. Make no mistake—this is very useful! Most of the functionality that used to be defined on `Future` itself has been moved to an extension trait called [`FuturesExt`](https://docs.rs/futures/0.3/futures/future/trait.FutureExt.html). From this information, you might be able to infer that the `futures` library serves as an extension to the core Rust async features.
In the same tradition as `futures`, `async-std` re-exports the core `std::future::Future` type. You can actively opt into the extensions provided by the `futures-preview` crate by adding it to your `Cargo.toml` and importing `FuturesExt`. In the same tradition as `futures`, `async-std` re-exports the core `std::future::Future` type. You can actively opt into the extensions provided by the `futures` crate by adding it to your `Cargo.toml` and importing `FuturesExt`.
## Interfaces and Stability ## Interfaces and Stability

@ -0,0 +1,266 @@
# Production-Ready Accept Loop
A production-ready accept loop needs the following things:
1. Handling errors
2. Limiting the number of simultanteous connections to avoid deny-of-service
(DoS) attacks
## Handling errors
There are two kinds of errors in an accept loop:
1. Per-connection errors. The system uses them to notify that there was a
connection in the queue and it's dropped by the peer. Subsequent connections
can be already queued so next connection must be accepted immediately.
2. Resource shortages. When these are encountered it doesn't make sense to
accept the next socket immediately. But the listener stays active, so you server
should try to accept socket later.
Here is the example of a per-connection error (printed in normal and debug mode):
```
Error: Connection reset by peer (os error 104)
Error: Os { code: 104, kind: ConnectionReset, message: "Connection reset by peer" }
```
And the following is the most common example of a resource shortage error:
```
Error: Too many open files (os error 24)
Error: Os { code: 24, kind: Other, message: "Too many open files" }
```
### Testing Application
To test your application for these errors try the following (this works
on unixes only).
Lower limits and start the application:
```
$ ulimit -n 100
$ cargo run --example your_app
Compiling your_app v0.1.0 (/work)
Finished dev [unoptimized + debuginfo] target(s) in 5.47s
Running `target/debug/examples/your_app`
Server is listening on: http://127.0.0.1:1234
```
Then in another console run the [`wrk`] benchmark tool:
```
$ wrk -c 1000 http://127.0.0.1:1234
Running 10s test @ http://localhost:8080/
2 threads and 1000 connections
$ telnet localhost 1234
Trying ::1...
Connected to localhost.
```
Important is to check the following things:
1. The application doesn't crash on error (but may log errors, see below)
2. It's possible to connect to the application again once load is stopped
(few seconds after `wrk`). This is what `telnet` does in example above,
make sure it prints `Connected to <hostname>`.
3. The `Too many open files` error is logged in the appropriate log. This
requires to set "maximum number of simultaneous connections" parameter (see
below) of your application to a value greater then `100` for this example.
4. Check CPU usage of the app while doing a test. It should not occupy 100%
of a single CPU core (it's unlikely that you can exhaust CPU by 1000
connections in Rust, so this means error handling is not right).
#### Testing non-HTTP applications
If it's possible, use the appropriate benchmark tool and set the appropriate
number of connections. For example `redis-benchmark` has a `-c` parameter for
that, if you implement redis protocol.
Alternatively, can still use `wrk`, just make sure that connection is not
immediately closed. If it is, put a temporary timeout before handing
the connection to the protocol handler, like this:
```rust,edition2018
# extern crate async_std;
# use std::time::Duration;
# use async_std::{
# net::{TcpListener, ToSocketAddrs},
# prelude::*,
# };
#
# type Result<T> = std::result::Result<T, Box<dyn std::error::Error + Send + Sync>>;
#
#async fn accept_loop(addr: impl ToSocketAddrs) -> Result<()> {
# let listener = TcpListener::bind(addr).await?;
# let mut incoming = listener.incoming();
while let Some(stream) = incoming.next().await {
task::spawn(async {
task::sleep(Duration::from_secs(10)).await; // 1
connection_loop(stream).await;
});
}
# Ok(())
# }
```
1. Make sure the sleep coroutine is inside the spawned task, not in the loop.
[`wrk`]: https://github.com/wg/wrk
### Handling Errors Manually
Here is how basic accept loop could look like:
```rust,edition2018
# extern crate async_std;
# use std::time::Duration;
# use async_std::{
# net::{TcpListener, ToSocketAddrs},
# prelude::*,
# };
#
# type Result<T> = std::result::Result<T, Box<dyn std::error::Error + Send + Sync>>;
#
async fn accept_loop(addr: impl ToSocketAddrs) -> Result<()> {
let listener = TcpListener::bind(addr).await?;
let mut incoming = listener.incoming();
while let Some(result) = incoming.next().await {
let stream = match stream {
Err(ref e) if is_connection_error(e) => continue, // 1
Err(e) => {
eprintln!("Error: {}. Pausing for 500ms."); // 3
task::sleep(Duration::from_millis(500)).await; // 2
continue;
}
Ok(s) => s,
};
// body
}
Ok(())
}
```
1. Ignore per-connection errors.
2. Sleep and continue on resource shortage.
3. It's important to log the message, because these errors commonly mean the
misconfiguration of the system and are helpful for operations people running
the application.
Be sure to [test your application](#testing-application).
### External Crates
The crate [`async-listen`] has a helper to achieve this task:
```rust,edition2018
# extern crate async_std;
# extern crate async_listen;
# use std::time::Duration;
# use async_std::{
# net::{TcpListener, ToSocketAddrs},
# prelude::*,
# };
#
# type Result<T> = std::result::Result<T, Box<dyn std::error::Error + Send + Sync>>;
#
use async_listen::{ListenExt, error_hint};
async fn accept_loop(addr: impl ToSocketAddrs) -> Result<()> {
let listener = TcpListener::bind(addr).await?;
let mut incoming = listener
.incoming()
.log_warnings(log_accept_error) // 1
.handle_errors(Duration::from_millis(500));
while let Some(socket) = incoming.next().await { // 2
// body
}
Ok(())
}
fn log_accept_error(e: &io::Error) {
eprintln!("Error: {}. Listener paused for 0.5s. {}", e, error_hint(e)) // 3
}
```
1. Logs resource shortages (`async-listen` calls them warnings). If you use
`log` crate or any other in your app this should go to the log.
2. Stream yields sockets without `Result` wrapper after `handle_errors` because
all errors are already handled.
3. Together with the error we print a hint, which explains some errors for end
users. For example, it recommends increasing open file limit and gives
a link.
[`async-listen`]: https://crates.io/crates/async-listen/
Be sure to [test your application](#testing-application).
## Connections Limit
Even if you've applied everything described in
[Handling Errors](#handling-errors) section, there is still a problem.
Let's imagine you have a server that needs to open a file to process
client request. At some point, you might encounter the following situation:
1. There are as many client connection as max file descriptors allowed for
the application.
2. Listener gets `Too many open files` error so it sleeps.
3. Some client sends a request via the previously open connection.
4. Opening a file to serve request fails, because of the same
`Too many open files` error, until some other client drops a connection.
There are many more possible situations, this is just a small illustation that
limiting number of connections is very useful. Generally, it's one of the ways
to control resources used by a server and avoiding some kinds of deny of
service (DoS) attacks.
### `async-listen` crate
Limiting maximum number of simultaneous connections with [`async-listen`]
looks like the following:
```rust,edition2018
# extern crate async_std;
# extern crate async_listen;
# use std::time::Duration;
# use async_std::{
# net::{TcpListener, TcpStream, ToSocketAddrs},
# prelude::*,
# };
#
# type Result<T> = std::result::Result<T, Box<dyn std::error::Error + Send + Sync>>;
#
use async_listen::{ListenExt, Token, error_hint};
async fn accept_loop(addr: impl ToSocketAddrs) -> Result<()> {
let listener = TcpListener::bind(addr).await?;
let mut incoming = listener
.incoming()
.log_warnings(log_accept_error)
.handle_errors(Duration::from_millis(500)) // 1
.backpressure(100);
while let Some((token, socket)) = incoming.next().await { // 2
task::spawn(async move {
connection_loop(&token, stream).await; // 3
});
}
Ok(())
}
async fn connection_loop(_token: &Token, stream: TcpStream) { // 4
// ...
}
# fn log_accept_error(e: &io::Error) {
# eprintln!("Error: {}. Listener paused for 0.5s. {}", e, error_hint(e));
# }
```
1. We need to handle errors first, because [`backpressure`] helper expects
stream of `TcpStream` rather than `Result`.
2. The token yielded by a new stream is what is counted by backpressure helper.
I.e. if you drop a token, new connection can be established.
3. We give the connection loop a reference to token to bind token's lifetime to
the lifetime of the connection.
4. The token itsellf in the function can be ignored, hence `_token`
[`backpressure`]: https://docs.rs/async-listen/0.1.2/async_listen/trait.ListenExt.html#method.backpressure
Be sure to [test this behavior](#testing-application).

@ -4,16 +4,15 @@ At this point, we only need to start the broker to get a fully-functioning (in t
```rust,edition2018 ```rust,edition2018
# extern crate async_std; # extern crate async_std;
# extern crate futures_channel; # extern crate futures;
# extern crate futures_util;
use async_std::{ use async_std::{
io::{self, BufReader}, io::BufReader,
net::{TcpListener, TcpStream, ToSocketAddrs}, net::{TcpListener, TcpStream, ToSocketAddrs},
prelude::*, prelude::*,
task, task,
}; };
use futures_channel::mpsc; use futures::channel::mpsc;
use futures_util::SinkExt; use futures::sink::SinkExt;
use std::{ use std::{
collections::hash_map::{HashMap, Entry}, collections::hash_map::{HashMap, Entry},
sync::Arc, sync::Arc,

@ -22,16 +22,15 @@ Let's add waiting to the server:
```rust,edition2018 ```rust,edition2018
# extern crate async_std; # extern crate async_std;
# extern crate futures_channel; # extern crate futures;
# extern crate futures_util;
# use async_std::{ # use async_std::{
# io::{self, BufReader}, # io::{self, BufReader},
# net::{TcpListener, TcpStream, ToSocketAddrs}, # net::{TcpListener, TcpStream, ToSocketAddrs},
# prelude::*, # prelude::*,
# task, # task,
# }; # };
# use futures_channel::mpsc; # use futures::channel::mpsc;
# use futures_util::SinkExt; # use futures::sink::SinkExt;
# use std::{ # use std::{
# collections::hash_map::{HashMap, Entry}, # collections::hash_map::{HashMap, Entry},
# sync::Arc, # sync::Arc,
@ -156,16 +155,15 @@ And to the broker:
```rust,edition2018 ```rust,edition2018
# extern crate async_std; # extern crate async_std;
# extern crate futures_channel; # extern crate futures;
# extern crate futures_util;
# use async_std::{ # use async_std::{
# io::{self, BufReader}, # io::{self, BufReader},
# net::{TcpListener, TcpStream, ToSocketAddrs}, # net::{TcpListener, TcpStream, ToSocketAddrs},
# prelude::*, # prelude::*,
# task, # task,
# }; # };
# use futures_channel::mpsc; # use futures::channel::mpsc;
# use futures_util::SinkExt; # use futures::sink::SinkExt;
# use std::{ # use std::{
# collections::hash_map::{HashMap, Entry}, # collections::hash_map::{HashMap, Entry},
# sync::Arc, # sync::Arc,

@ -2,25 +2,24 @@
## Connecting Readers and Writers ## Connecting Readers and Writers
So how do we make sure that messages read in `connection_loop` flow into the relevant `connection_writer_loop`? So how do we make sure that messages read in `connection_loop` flow into the relevant `connection_writer_loop`?
We should somehow maintain an `peers: HashMap<String, Sender<String>>` map which allows a client to find destination channels. We should somehow maintain a `peers: HashMap<String, Sender<String>>` map which allows a client to find destination channels.
However, this map would be a bit of shared mutable state, so we'll have to wrap an `RwLock` over it and answer tough questions of what should happen if the client joins at the same moment as it receives a message. However, this map would be a bit of shared mutable state, so we'll have to wrap an `RwLock` over it and answer tough questions of what should happen if the client joins at the same moment as it receives a message.
One trick to make reasoning about state simpler comes from the actor model. One trick to make reasoning about state simpler comes from the actor model.
We can create a dedicated broker tasks which owns the `peers` map and communicates with other tasks by channels. We can create a dedicated broker task which owns the `peers` map and communicates with other tasks using channels.
By hiding `peers` inside such an "actor" task, we remove the need for mutxes and also make serialization point explicit. By hiding `peers` inside such an "actor" task, we remove the need for mutexes and also make the serialization point explicit.
The order of events "Bob sends message to Alice" and "Alice joins" is determined by the order of the corresponding events in the broker's event queue. The order of events "Bob sends message to Alice" and "Alice joins" is determined by the order of the corresponding events in the broker's event queue.
```rust,edition2018 ```rust,edition2018
# extern crate async_std; # extern crate async_std;
# extern crate futures_channel; # extern crate futures;
# extern crate futures_util;
# use async_std::{ # use async_std::{
# net::TcpStream, # net::TcpStream,
# prelude::*, # prelude::*,
# task, # task,
# }; # };
# use futures_channel::mpsc; # use futures::channel::mpsc;
# use futures_util::sink::SinkExt; # use futures::sink::SinkExt;
# use std::sync::Arc; # use std::sync::Arc;
# #
# type Result<T> = std::result::Result<T, Box<dyn std::error::Error + Send + Sync>>; # type Result<T> = std::result::Result<T, Box<dyn std::error::Error + Send + Sync>>;
@ -93,9 +92,9 @@ async fn broker_loop(mut events: Receiver<Event>) -> Result<()> {
} }
``` ```
1. Broker should handle two types of events: a message or an arrival of a new peer. 1. The broker task should handle two types of events: a message or an arrival of a new peer.
2. Internal state of the broker is a `HashMap`. 2. The internal state of the broker is a `HashMap`.
Note how we don't need a `Mutex` here and can confidently say, at each iteration of the broker's loop, what is the current set of peers Note how we don't need a `Mutex` here and can confidently say, at each iteration of the broker's loop, what is the current set of peers
3. To handle a message, we send it over a channel to each destination 3. To handle a message, we send it over a channel to each destination
4. To handle new peer, we first register it in the peer's map ... 4. To handle a new peer, we first register it in the peer's map ...
5. ... and then spawn a dedicated task to actually write the messages to the socket. 5. ... and then spawn a dedicated task to actually write the messages to the socket.

@ -19,11 +19,10 @@ First, let's add a shutdown channel to the `connection_loop`:
```rust,edition2018 ```rust,edition2018
# extern crate async_std; # extern crate async_std;
# extern crate futures_channel; # extern crate futures;
# extern crate futures_util;
# use async_std::net::TcpStream; # use async_std::net::TcpStream;
# use futures_channel::mpsc; # use futures::channel::mpsc;
# use futures_util::SinkExt; # use futures::sink::SinkExt;
# use std::sync::Arc; # use std::sync::Arc;
# #
# type Result<T> = std::result::Result<T, Box<dyn std::error::Error + Send + Sync>>; # type Result<T> = std::result::Result<T, Box<dyn std::error::Error + Send + Sync>>;
@ -61,8 +60,8 @@ async fn connection_loop(mut broker: Sender<Event>, stream: Arc<TcpStream>) -> R
} }
``` ```
1. To enforce that no messages are send along the shutdown channel, we use an uninhabited type. 1. To enforce that no messages are sent along the shutdown channel, we use an uninhabited type.
2. We pass the shutdown channel to the writer task 2. We pass the shutdown channel to the writer task.
3. In the reader, we create a `_shutdown_sender` whose only purpose is to get dropped. 3. In the reader, we create a `_shutdown_sender` whose only purpose is to get dropped.
In the `connection_writer_loop`, we now need to choose between shutdown and message channels. In the `connection_writer_loop`, we now need to choose between shutdown and message channels.
@ -70,17 +69,14 @@ We use the `select` macro for this purpose:
```rust,edition2018 ```rust,edition2018
# extern crate async_std; # extern crate async_std;
# extern crate futures_channel; # extern crate futures;
# extern crate futures_util;
# use async_std::{net::TcpStream, prelude::*}; # use async_std::{net::TcpStream, prelude::*};
use futures_channel::mpsc; # use futures::channel::mpsc;
use futures_util::{select, FutureExt}; use futures::{select, FutureExt};
# use std::sync::Arc; # use std::sync::Arc;
# type Receiver<T> = mpsc::UnboundedReceiver<T>; # type Receiver<T> = mpsc::UnboundedReceiver<T>;
# type Result<T> = std::result::Result<T, Box<dyn std::error::Error + Send + Sync>>; # type Result<T> = std::result::Result<T, Box<dyn std::error::Error + Send + Sync>>;
# type Sender<T> = mpsc::UnboundedSender<T>; # type Sender<T> = mpsc::UnboundedSender<T>;
# #[derive(Debug)] # #[derive(Debug)]
# enum Void {} // 1 # enum Void {} // 1
@ -114,7 +110,7 @@ async fn connection_writer_loop(
Another problem is that between the moment we detect disconnection in `connection_writer_loop` and the moment when we actually remove the peer from the `peers` map, new messages might be pushed into the peer's channel. Another problem is that between the moment we detect disconnection in `connection_writer_loop` and the moment when we actually remove the peer from the `peers` map, new messages might be pushed into the peer's channel.
To not lose these messages completely, we'll return the messages channel back to the broker. To not lose these messages completely, we'll return the messages channel back to the broker.
This also allows us to establish a useful invariant that the message channel strictly outlives the peer in the `peers` map, and makes the broker itself infailable. This also allows us to establish a useful invariant that the message channel strictly outlives the peer in the `peers` map, and makes the broker itself infallible.
## Final Code ## Final Code
@ -122,16 +118,16 @@ The final code looks like this:
```rust,edition2018 ```rust,edition2018
# extern crate async_std; # extern crate async_std;
# extern crate futures_channel; # extern crate futures;
# extern crate futures_util;
use async_std::{ use async_std::{
io::BufReader, io::BufReader,
net::{TcpListener, TcpStream, ToSocketAddrs}, net::{TcpListener, TcpStream, ToSocketAddrs},
prelude::*, prelude::*,
task, task,
}; };
use futures_channel::mpsc; use futures::channel::mpsc;
use futures_util::{select, FutureExt, SinkExt}; use futures::sink::SinkExt;
use futures::{select, FutureExt};
use std::{ use std::{
collections::hash_map::{Entry, HashMap}, collections::hash_map::{Entry, HashMap},
future::Future, future::Future,

@ -1,29 +1,27 @@
## Implementing a client ## Implementing a client
Let's now implement the client for the chat. Since the protocol is line-based, implementing a client for the chat is straightforward:
Because the protocol is line-based, the implementation is pretty straightforward:
* Lines read from stdin should be sent over the socket. * Lines read from stdin should be sent over the socket.
* Lines read from the socket should be echoed to stdout. * Lines read from the socket should be echoed to stdout.
Unlike the server, the client needs only limited concurrency, as it interacts with only a single user. Although async does not significantly affect client performance (as unlike the server, the client interacts solely with one user and only needs limited concurrency), async is still useful for managing concurrency!
For this reason, async doesn't bring a lot of performance benefits in this case.
The client has to read from stdin and the socket *simultaneously*.
Programming this with threads is cumbersome, especially when implementing a clean shutdown.
With async, the `select!` macro is all that is needed.
However, async is still useful for managing concurrency!
Specifically, the client should *simultaneously* read from stdin and from the socket.
Programming this with threads is cumbersome, especially when implementing clean shutdown.
With async, we can just use the `select!` macro.
```rust,edition2018 ```rust,edition2018
# extern crate async_std; # extern crate async_std;
# extern crate futures_util; # extern crate futures;
use async_std::{ use async_std::{
io::{stdin, BufReader}, io::{stdin, BufReader},
net::{TcpStream, ToSocketAddrs}, net::{TcpStream, ToSocketAddrs},
prelude::*, prelude::*,
task, task,
}; };
use futures_util::{select, FutureExt}; use futures::{select, FutureExt};
type Result<T> = std::result::Result<T, Box<dyn std::error::Error + Send + Sync>>; type Result<T> = std::result::Result<T, Box<dyn std::error::Error + Send + Sync>>;

@ -1,11 +1,14 @@
# Tutorial: Writing a chat # Tutorial: Writing a chat
Nothing is as simple as a chat server, right? Not quite, chat servers Nothing is simpler than creating a chat server, right?
already expose you to all the fun of asynchronous programming: how Not quite, chat servers expose you to all the fun of asynchronous programming:
do you handle clients connecting concurrently. How do you handle them disconnecting?
How do you distribute the messages? How will the server handle clients connecting concurrently?
In this tutorial, we will show you how to write one in `async-std`. How will it handle them disconnecting?
How will it distribute the messages?
This tutorial explains how to write a chat server in `async-std`.
You can also find the tutorial in [our repository](https://github.com/async-rs/async-std/blob/master/examples/a-chat). You can also find the tutorial in [our repository](https://github.com/async-rs/async-std/blob/master/examples/a-chat).

@ -10,14 +10,18 @@ We need to:
```rust,edition2018 ```rust,edition2018
# extern crate async_std; # extern crate async_std;
# use async_std::{ # use async_std::{
# io::BufReader, # net::{TcpListener, ToSocketAddrs},
# net::{TcpListener, TcpStream, ToSocketAddrs},
# prelude::*, # prelude::*,
# task, # task,
# }; # };
# #
# type Result<T> = std::result::Result<T, Box<dyn std::error::Error + Send + Sync>>; # type Result<T> = std::result::Result<T, Box<dyn std::error::Error + Send + Sync>>;
# #
use async_std::{
io::BufReader,
net::TcpStream,
};
async fn accept_loop(addr: impl ToSocketAddrs) -> Result<()> { async fn accept_loop(addr: impl ToSocketAddrs) -> Result<()> {
let listener = TcpListener::bind(addr).await?; let listener = TcpListener::bind(addr).await?;
let mut incoming = listener.incoming(); let mut incoming = listener.incoming();
@ -46,7 +50,7 @@ async fn connection_loop(stream: TcpStream) -> Result<()> {
Some(idx) => (&line[..idx], line[idx + 1 ..].trim()), Some(idx) => (&line[..idx], line[idx + 1 ..].trim()),
}; };
let dest: Vec<String> = dest.split(',').map(|name| name.trim().to_string()).collect(); let dest: Vec<String> = dest.split(',').map(|name| name.trim().to_string()).collect();
let msg: String = msg.trim().to_string(); let msg: String = msg.to_string();
} }
Ok(()) Ok(())
} }
@ -107,7 +111,7 @@ We can "fix" it by waiting for the task to be joined, like this:
# #
# async move |stream| { # async move |stream| {
let handle = task::spawn(connection_loop(stream)); let handle = task::spawn(connection_loop(stream));
handle.await handle.await?
# }; # };
``` ```
@ -130,7 +134,7 @@ So let's use a helper function for this:
# }; # };
fn spawn_and_log_error<F>(fut: F) -> task::JoinHandle<()> fn spawn_and_log_error<F>(fut: F) -> task::JoinHandle<()>
where where
F: Future<Output = io::Result<()>> + Send + 'static, F: Future<Output = Result<()>> + Send + 'static,
{ {
task::spawn(async move { task::spawn(async move {
if let Err(e) = fut.await { if let Err(e) = fut.await {

@ -13,14 +13,13 @@ if Alice and Charley send two messages to Bob at the same time, Bob will see the
```rust,edition2018 ```rust,edition2018
# extern crate async_std; # extern crate async_std;
# extern crate futures_channel; # extern crate futures;
# extern crate futures_util;
# use async_std::{ # use async_std::{
# net::TcpStream, # net::TcpStream,
# prelude::*, # prelude::*,
# }; # };
use futures_channel::mpsc; // 1 use futures::channel::mpsc; // 1
use futures_util::sink::SinkExt; use futures::sink::SinkExt;
use std::sync::Arc; use std::sync::Arc;
# type Result<T> = std::result::Result<T, Box<dyn std::error::Error + Send + Sync>>; # type Result<T> = std::result::Result<T, Box<dyn std::error::Error + Send + Sync>>;

@ -12,7 +12,7 @@ After that, the client can send messages to other clients using the following sy
login1, login2, ... loginN: message login1, login2, ... loginN: message
``` ```
Each of the specified clients than receives a `from login: message` message. Each of the specified clients then receives a `from login: message` message.
A possible session might look like this A possible session might look like this
@ -38,18 +38,10 @@ $ cargo new a-chat
$ cd a-chat $ cd a-chat
``` ```
At the moment `async-std` requires Rust nightly, so let's add a rustup override for convenience:
```bash
$ rustup override add nightly
$ rustc --version
rustc 1.38.0-nightly (c4715198b 2019-08-05)
```
Add the following lines to `Cargo.toml`: Add the following lines to `Cargo.toml`:
```toml ```toml
[dependencies] [dependencies]
futures-preview = { version = "0.3.0-alpha.19", features = [ "async-await" ] } futures = "0.3.0"
async-std = "0.99" async-std = "1"
``` ```

@ -1,6 +1,3 @@
/* TODO: Once the next version of surf released, re-enable this example.
//! Sends an HTTP request to the Rust website.
use async_std::task; use async_std::task;
fn main() -> Result<(), surf::Exception> { fn main() -> Result<(), surf::Exception> {
@ -18,6 +15,3 @@ fn main() -> Result<(), surf::Exception> {
Ok(()) Ok(())
}) })
} }
*/
fn main() {}

@ -14,8 +14,9 @@ use async_std::task;
async fn process(stream: TcpStream) -> io::Result<()> { async fn process(stream: TcpStream) -> io::Result<()> {
println!("Accepted from: {}", stream.peer_addr()?); println!("Accepted from: {}", stream.peer_addr()?);
let (reader, writer) = &mut (&stream, &stream); let mut reader = stream.clone();
io::copy(reader, writer).await?; let mut writer = stream;
io::copy(&mut reader, &mut writer).await?;
Ok(()) Ok(())
} }

@ -0,0 +1,45 @@
//! TCP echo server, accepting connections both on both ipv4 and ipv6 sockets.
//!
//! To send messages, do:
//!
//! ```sh
//! $ nc 127.0.0.1 8080
//! $ nc ::1 8080
//! ```
use async_std::io;
use async_std::net::{TcpListener, TcpStream};
use async_std::prelude::*;
use async_std::task;
async fn process(stream: TcpStream) -> io::Result<()> {
println!("Accepted from: {}", stream.peer_addr()?);
let mut reader = stream.clone();
let mut writer = stream;
io::copy(&mut reader, &mut writer).await?;
Ok(())
}
fn main() -> io::Result<()> {
task::block_on(async {
let ipv4_listener = TcpListener::bind("127.0.0.1:8080").await?;
println!("Listening on {}", ipv4_listener.local_addr()?);
let ipv6_listener = TcpListener::bind("[::1]:8080").await?;
println!("Listening on {}", ipv6_listener.local_addr()?);
let ipv4_incoming = ipv4_listener.incoming();
let ipv6_incoming = ipv6_listener.incoming();
let mut incoming = ipv4_incoming.merge(ipv6_incoming);
while let Some(stream) = incoming.next().await {
let stream = stream?;
task::spawn(async {
process(stream).await.unwrap();
});
}
Ok(())
})
}

@ -2,13 +2,16 @@ use std::collections::BinaryHeap;
use std::pin::Pin; use std::pin::Pin;
use crate::prelude::*; use crate::prelude::*;
use crate::stream::{Extend, IntoStream}; use crate::stream::{self, IntoStream};
impl<T: Ord> Extend<T> for BinaryHeap<T> { impl<T: Ord + Send> stream::Extend<T> for BinaryHeap<T> {
fn stream_extend<'a, S: IntoStream<Item = T> + 'a>( fn extend<'a, S: IntoStream<Item = T> + 'a>(
&'a mut self, &'a mut self,
stream: S, stream: S,
) -> Pin<Box<dyn Future<Output = ()> + 'a>> { ) -> Pin<Box<dyn Future<Output = ()> + 'a + Send>>
where
<S as IntoStream>::IntoStream: Send,
{
let stream = stream.into_stream(); let stream = stream.into_stream();
self.reserve(stream.size_hint().0); self.reserve(stream.size_hint().0);

@ -1,23 +1,22 @@
use std::collections::BinaryHeap; use std::collections::BinaryHeap;
use std::pin::Pin; use std::pin::Pin;
use crate::stream::{Extend, FromStream, IntoStream}; use crate::prelude::*;
use crate::stream::{self, FromStream, IntoStream};
impl<T: Ord> FromStream<T> for BinaryHeap<T> { impl<T: Ord + Send> FromStream<T> for BinaryHeap<T> {
#[inline] #[inline]
fn from_stream<'a, S: IntoStream<Item = T>>( fn from_stream<'a, S: IntoStream<Item = T> + 'a>(
stream: S, stream: S,
) -> Pin<Box<dyn core::future::Future<Output = Self> + 'a>> ) -> Pin<Box<dyn Future<Output = Self> + 'a + Send>>
where where
<S as IntoStream>::IntoStream: 'a, <S as IntoStream>::IntoStream: Send,
{ {
let stream = stream.into_stream(); let stream = stream.into_stream();
Box::pin(async move { Box::pin(async move {
pin_utils::pin_mut!(stream);
let mut out = BinaryHeap::new(); let mut out = BinaryHeap::new();
out.stream_extend(stream).await; stream::extend(&mut out, stream).await;
out out
}) })
} }

@ -2,13 +2,16 @@ use std::collections::BTreeMap;
use std::pin::Pin; use std::pin::Pin;
use crate::prelude::*; use crate::prelude::*;
use crate::stream::{Extend, IntoStream}; use crate::stream::{self, IntoStream};
impl<K: Ord, V> Extend<(K, V)> for BTreeMap<K, V> { impl<K: Ord + Send, V: Send> stream::Extend<(K, V)> for BTreeMap<K, V> {
fn stream_extend<'a, S: IntoStream<Item = (K, V)> + 'a>( fn extend<'a, S: IntoStream<Item = (K, V)> + 'a>(
&'a mut self, &'a mut self,
stream: S, stream: S,
) -> Pin<Box<dyn Future<Output = ()> + 'a>> { ) -> Pin<Box<dyn Future<Output = ()> + 'a + Send>>
where
<S as IntoStream>::IntoStream: Send,
{
Box::pin(stream.into_stream().for_each(move |(k, v)| { Box::pin(stream.into_stream().for_each(move |(k, v)| {
self.insert(k, v); self.insert(k, v);
})) }))

@ -1,23 +1,22 @@
use std::collections::BTreeMap; use std::collections::BTreeMap;
use std::pin::Pin; use std::pin::Pin;
use crate::stream::{Extend, FromStream, IntoStream}; use crate::prelude::*;
use crate::stream::{self, FromStream, IntoStream};
impl<K: Ord, V> FromStream<(K, V)> for BTreeMap<K, V> { impl<K: Ord + Send, V: Send> FromStream<(K, V)> for BTreeMap<K, V> {
#[inline] #[inline]
fn from_stream<'a, S: IntoStream<Item = (K, V)>>( fn from_stream<'a, S: IntoStream<Item = (K, V)> + 'a>(
stream: S, stream: S,
) -> Pin<Box<dyn core::future::Future<Output = Self> + 'a>> ) -> Pin<Box<dyn Future<Output = Self> + 'a + Send>>
where where
<S as IntoStream>::IntoStream: 'a, <S as IntoStream>::IntoStream: Send,
{ {
let stream = stream.into_stream(); let stream = stream.into_stream();
Box::pin(async move { Box::pin(async move {
pin_utils::pin_mut!(stream);
let mut out = BTreeMap::new(); let mut out = BTreeMap::new();
out.stream_extend(stream).await; stream::extend(&mut out, stream).await;
out out
}) })
} }

@ -2,13 +2,16 @@ use std::collections::BTreeSet;
use std::pin::Pin; use std::pin::Pin;
use crate::prelude::*; use crate::prelude::*;
use crate::stream::{Extend, IntoStream}; use crate::stream::{self, IntoStream};
impl<T: Ord> Extend<T> for BTreeSet<T> { impl<T: Ord + Send> stream::Extend<T> for BTreeSet<T> {
fn stream_extend<'a, S: IntoStream<Item = T> + 'a>( fn extend<'a, S: IntoStream<Item = T> + 'a>(
&'a mut self, &'a mut self,
stream: S, stream: S,
) -> Pin<Box<dyn Future<Output = ()> + 'a>> { ) -> Pin<Box<dyn Future<Output = ()> + 'a + Send>>
where
<S as IntoStream>::IntoStream: Send,
{
Box::pin(stream.into_stream().for_each(move |item| { Box::pin(stream.into_stream().for_each(move |item| {
self.insert(item); self.insert(item);
})) }))

@ -1,23 +1,22 @@
use std::collections::BTreeSet; use std::collections::BTreeSet;
use std::pin::Pin; use std::pin::Pin;
use crate::stream::{Extend, FromStream, IntoStream}; use crate::prelude::*;
use crate::stream::{self, FromStream, IntoStream};
impl<T: Ord> FromStream<T> for BTreeSet<T> { impl<T: Ord + Send> FromStream<T> for BTreeSet<T> {
#[inline] #[inline]
fn from_stream<'a, S: IntoStream<Item = T>>( fn from_stream<'a, S: IntoStream<Item = T> + 'a>(
stream: S, stream: S,
) -> Pin<Box<dyn core::future::Future<Output = Self> + 'a>> ) -> Pin<Box<dyn Future<Output = Self> + 'a + Send>>
where where
<S as IntoStream>::IntoStream: 'a, <S as IntoStream>::IntoStream: Send,
{ {
let stream = stream.into_stream(); let stream = stream.into_stream();
Box::pin(async move { Box::pin(async move {
pin_utils::pin_mut!(stream);
let mut out = BTreeSet::new(); let mut out = BTreeSet::new();
out.stream_extend(stream).await; stream::extend(&mut out, stream).await;
out out
}) })
} }

@ -3,17 +3,21 @@ use std::hash::{BuildHasher, Hash};
use std::pin::Pin; use std::pin::Pin;
use crate::prelude::*; use crate::prelude::*;
use crate::stream::{Extend, IntoStream}; use crate::stream::{self, IntoStream};
impl<K, V, H> Extend<(K, V)> for HashMap<K, V, H> impl<K, V, H> stream::Extend<(K, V)> for HashMap<K, V, H>
where where
K: Eq + Hash, K: Eq + Hash + Send,
H: BuildHasher + Default, V: Send,
H: BuildHasher + Default + Send,
{ {
fn stream_extend<'a, S: IntoStream<Item = (K, V)> + 'a>( fn extend<'a, S: IntoStream<Item = (K, V)> + 'a>(
&'a mut self, &'a mut self,
stream: S, stream: S,
) -> Pin<Box<dyn Future<Output = ()> + 'a>> { ) -> Pin<Box<dyn Future<Output = ()> + 'a + Send>>
where
<S as IntoStream>::IntoStream: Send,
{
let stream = stream.into_stream(); let stream = stream.into_stream();
// The following is adapted from the hashbrown source code: // The following is adapted from the hashbrown source code:

@ -2,27 +2,27 @@ use std::collections::HashMap;
use std::hash::{BuildHasher, Hash}; use std::hash::{BuildHasher, Hash};
use std::pin::Pin; use std::pin::Pin;
use crate::stream::{Extend, FromStream, IntoStream}; use crate::prelude::*;
use crate::stream::{self, FromStream, IntoStream};
impl<K, V, H> FromStream<(K, V)> for HashMap<K, V, H> impl<K, V, H> FromStream<(K, V)> for HashMap<K, V, H>
where where
K: Eq + Hash, K: Eq + Hash + Send,
H: BuildHasher + Default, H: BuildHasher + Default + Send,
V: Send,
{ {
#[inline] #[inline]
fn from_stream<'a, S: IntoStream<Item = (K, V)>>( fn from_stream<'a, S: IntoStream<Item = (K, V)> + 'a>(
stream: S, stream: S,
) -> Pin<Box<dyn core::future::Future<Output = Self> + 'a>> ) -> Pin<Box<dyn Future<Output = Self> + 'a + Send>>
where where
<S as IntoStream>::IntoStream: 'a, <S as IntoStream>::IntoStream: Send,
{ {
let stream = stream.into_stream(); let stream = stream.into_stream();
Box::pin(async move { Box::pin(async move {
pin_utils::pin_mut!(stream);
let mut out = HashMap::with_hasher(Default::default()); let mut out = HashMap::with_hasher(Default::default());
out.stream_extend(stream).await; stream::extend(&mut out, stream).await;
out out
}) })
} }

@ -3,17 +3,20 @@ use std::hash::{BuildHasher, Hash};
use std::pin::Pin; use std::pin::Pin;
use crate::prelude::*; use crate::prelude::*;
use crate::stream::{Extend, IntoStream}; use crate::stream::{self, IntoStream};
impl<T, H> Extend<T> for HashSet<T, H> impl<T, H> stream::Extend<T> for HashSet<T, H>
where where
T: Eq + Hash, T: Eq + Hash + Send,
H: BuildHasher + Default, H: BuildHasher + Default + Send,
{ {
fn stream_extend<'a, S: IntoStream<Item = T> + 'a>( fn extend<'a, S: IntoStream<Item = T> + 'a>(
&'a mut self, &'a mut self,
stream: S, stream: S,
) -> Pin<Box<dyn Future<Output = ()> + 'a>> { ) -> Pin<Box<dyn Future<Output = ()> + 'a + Send>>
where
<S as IntoStream>::IntoStream: Send,
{
// The Extend impl for HashSet in the standard library delegates to the internal HashMap. // The Extend impl for HashSet in the standard library delegates to the internal HashMap.
// Thus, this impl is just a copy of the async Extend impl for HashMap in this crate. // Thus, this impl is just a copy of the async Extend impl for HashMap in this crate.

@ -2,27 +2,26 @@ use std::collections::HashSet;
use std::hash::{BuildHasher, Hash}; use std::hash::{BuildHasher, Hash};
use std::pin::Pin; use std::pin::Pin;
use crate::stream::{Extend, FromStream, IntoStream}; use crate::prelude::*;
use crate::stream::{self, FromStream, IntoStream};
impl<T, H> FromStream<T> for HashSet<T, H> impl<T, H> FromStream<T> for HashSet<T, H>
where where
T: Eq + Hash, T: Eq + Hash + Send,
H: BuildHasher + Default, H: BuildHasher + Default + Send,
{ {
#[inline] #[inline]
fn from_stream<'a, S: IntoStream<Item = T>>( fn from_stream<'a, S: IntoStream<Item = T> + 'a>(
stream: S, stream: S,
) -> Pin<Box<dyn core::future::Future<Output = Self> + 'a>> ) -> Pin<Box<dyn Future<Output = Self> + 'a + Send>>
where where
<S as IntoStream>::IntoStream: 'a, <S as IntoStream>::IntoStream: Send,
{ {
let stream = stream.into_stream(); let stream = stream.into_stream();
Box::pin(async move { Box::pin(async move {
pin_utils::pin_mut!(stream);
let mut out = HashSet::with_hasher(Default::default()); let mut out = HashSet::with_hasher(Default::default());
out.stream_extend(stream).await; stream::extend(&mut out, stream).await;
out out
}) })
} }

@ -2,13 +2,16 @@ use std::collections::LinkedList;
use std::pin::Pin; use std::pin::Pin;
use crate::prelude::*; use crate::prelude::*;
use crate::stream::{Extend, IntoStream}; use crate::stream::{self, IntoStream};
impl<T> Extend<T> for LinkedList<T> { impl<T: Send> stream::Extend<T> for LinkedList<T> {
fn stream_extend<'a, S: IntoStream<Item = T> + 'a>( fn extend<'a, S: IntoStream<Item = T> + 'a>(
&'a mut self, &'a mut self,
stream: S, stream: S,
) -> Pin<Box<dyn Future<Output = ()> + 'a>> { ) -> Pin<Box<dyn Future<Output = ()> + 'a + Send>>
where
<S as IntoStream>::IntoStream: Send,
{
let stream = stream.into_stream(); let stream = stream.into_stream();
Box::pin(stream.for_each(move |item| self.push_back(item))) Box::pin(stream.for_each(move |item| self.push_back(item)))
} }

@ -1,23 +1,22 @@
use std::collections::LinkedList; use std::collections::LinkedList;
use std::pin::Pin; use std::pin::Pin;
use crate::stream::{Extend, FromStream, IntoStream}; use crate::prelude::*;
use crate::stream::{self, FromStream, IntoStream};
impl<T> FromStream<T> for LinkedList<T> { impl<T: Send> FromStream<T> for LinkedList<T> {
#[inline] #[inline]
fn from_stream<'a, S: IntoStream<Item = T>>( fn from_stream<'a, S: IntoStream<Item = T> + 'a>(
stream: S, stream: S,
) -> Pin<Box<dyn core::future::Future<Output = Self> + 'a>> ) -> Pin<Box<dyn Future<Output = Self> + 'a + Send>>
where where
<S as IntoStream>::IntoStream: 'a, <S as IntoStream>::IntoStream: Send,
{ {
let stream = stream.into_stream(); let stream = stream.into_stream();
Box::pin(async move { Box::pin(async move {
pin_utils::pin_mut!(stream);
let mut out = LinkedList::new(); let mut out = LinkedList::new();
out.stream_extend(stream).await; stream::extend(&mut out, stream).await;
out out
}) })
} }

@ -2,13 +2,16 @@ use std::collections::VecDeque;
use std::pin::Pin; use std::pin::Pin;
use crate::prelude::*; use crate::prelude::*;
use crate::stream::{Extend, IntoStream}; use crate::stream::{self, IntoStream};
impl<T> Extend<T> for VecDeque<T> { impl<T: Send> stream::Extend<T> for VecDeque<T> {
fn stream_extend<'a, S: IntoStream<Item = T> + 'a>( fn extend<'a, S: IntoStream<Item = T> + 'a>(
&'a mut self, &'a mut self,
stream: S, stream: S,
) -> Pin<Box<dyn Future<Output = ()> + 'a>> { ) -> Pin<Box<dyn Future<Output = ()> + 'a + Send>>
where
<S as IntoStream>::IntoStream: Send,
{
let stream = stream.into_stream(); let stream = stream.into_stream();
self.reserve(stream.size_hint().0); self.reserve(stream.size_hint().0);

@ -1,23 +1,22 @@
use std::collections::VecDeque; use std::collections::VecDeque;
use std::pin::Pin; use std::pin::Pin;
use crate::stream::{Extend, FromStream, IntoStream}; use crate::prelude::*;
use crate::stream::{self, FromStream, IntoStream};
impl<T> FromStream<T> for VecDeque<T> { impl<T: Send> FromStream<T> for VecDeque<T> {
#[inline] #[inline]
fn from_stream<'a, S: IntoStream<Item = T>>( fn from_stream<'a, S: IntoStream<Item = T> + 'a>(
stream: S, stream: S,
) -> Pin<Box<dyn core::future::Future<Output = Self> + 'a>> ) -> Pin<Box<dyn Future<Output = Self> + 'a + Send>>
where where
<S as IntoStream>::IntoStream: 'a, <S as IntoStream>::IntoStream: Send,
{ {
let stream = stream.into_stream(); let stream = stream.into_stream();
Box::pin(async move { Box::pin(async move {
pin_utils::pin_mut!(stream);
let mut out = VecDeque::new(); let mut out = VecDeque::new();
out.stream_extend(stream).await; stream::extend(&mut out, stream).await;
out out
}) })
} }

@ -1,6 +1,7 @@
use crate::io; use crate::io;
use crate::path::{Path, PathBuf}; use crate::path::{Path, PathBuf};
use crate::task::blocking; use crate::task::spawn_blocking;
use crate::utils::Context as _;
/// Returns the canonical form of a path. /// Returns the canonical form of a path.
/// ///
@ -32,5 +33,10 @@ use crate::task::blocking;
/// ``` /// ```
pub async fn canonicalize<P: AsRef<Path>>(path: P) -> io::Result<PathBuf> { pub async fn canonicalize<P: AsRef<Path>>(path: P) -> io::Result<PathBuf> {
let path = path.as_ref().to_owned(); let path = path.as_ref().to_owned();
blocking::spawn(move || std::fs::canonicalize(&path).map(Into::into)).await spawn_blocking(move || {
std::fs::canonicalize(&path)
.map(Into::into)
.context(|| format!("could not canonicalize `{}`", path.display()))
})
.await
} }

@ -1,6 +1,7 @@
use crate::io; use crate::io;
use crate::path::Path; use crate::path::Path;
use crate::task::blocking; use crate::task::spawn_blocking;
use crate::utils::Context as _;
/// Copies the contents and permissions of a file to a new location. /// Copies the contents and permissions of a file to a new location.
/// ///
@ -41,5 +42,9 @@ use crate::task::blocking;
pub async fn copy<P: AsRef<Path>, Q: AsRef<Path>>(from: P, to: Q) -> io::Result<u64> { pub async fn copy<P: AsRef<Path>, Q: AsRef<Path>>(from: P, to: Q) -> io::Result<u64> {
let from = from.as_ref().to_owned(); let from = from.as_ref().to_owned();
let to = to.as_ref().to_owned(); let to = to.as_ref().to_owned();
blocking::spawn(move || std::fs::copy(&from, &to)).await spawn_blocking(move || {
std::fs::copy(&from, &to)
.context(|| format!("could not copy `{}` to `{}`", from.display(), to.display()))
})
.await
} }

@ -1,6 +1,7 @@
use crate::io; use crate::io;
use crate::path::Path; use crate::path::Path;
use crate::task::blocking; use crate::task::spawn_blocking;
use crate::utils::Context as _;
/// Creates a new directory. /// Creates a new directory.
/// ///
@ -34,5 +35,9 @@ use crate::task::blocking;
/// ``` /// ```
pub async fn create_dir<P: AsRef<Path>>(path: P) -> io::Result<()> { pub async fn create_dir<P: AsRef<Path>>(path: P) -> io::Result<()> {
let path = path.as_ref().to_owned(); let path = path.as_ref().to_owned();
blocking::spawn(move || std::fs::create_dir(path)).await spawn_blocking(move || {
std::fs::create_dir(&path)
.context(|| format!("could not create directory `{}`", path.display()))
})
.await
} }

@ -1,6 +1,7 @@
use crate::io; use crate::io;
use crate::path::Path; use crate::path::Path;
use crate::task::blocking; use crate::task::spawn_blocking;
use crate::utils::Context as _;
/// Creates a new directory and all of its parents if they are missing. /// Creates a new directory and all of its parents if they are missing.
/// ///
@ -29,5 +30,9 @@ use crate::task::blocking;
/// ``` /// ```
pub async fn create_dir_all<P: AsRef<Path>>(path: P) -> io::Result<()> { pub async fn create_dir_all<P: AsRef<Path>>(path: P) -> io::Result<()> {
let path = path.as_ref().to_owned(); let path = path.as_ref().to_owned();
blocking::spawn(move || std::fs::create_dir_all(path)).await spawn_blocking(move || {
std::fs::create_dir_all(&path)
.context(|| format!("could not create directory path `{}`", path.display()))
})
.await
} }

@ -2,7 +2,7 @@ use std::future::Future;
use crate::io; use crate::io;
use crate::path::Path; use crate::path::Path;
use crate::task::blocking; use crate::task::spawn_blocking;
/// A builder for creating directories with configurable options. /// A builder for creating directories with configurable options.
/// ///
@ -107,7 +107,7 @@ impl DirBuilder {
} }
let path = path.as_ref().to_owned(); let path = path.as_ref().to_owned();
async move { blocking::spawn(move || builder.create(path)).await } async move { spawn_blocking(move || builder.create(path)).await }
} }
} }

@ -5,7 +5,7 @@ use std::sync::Arc;
use crate::fs::{FileType, Metadata}; use crate::fs::{FileType, Metadata};
use crate::io; use crate::io;
use crate::path::PathBuf; use crate::path::PathBuf;
use crate::task::blocking; use crate::task::spawn_blocking;
/// An entry in a directory. /// An entry in a directory.
/// ///
@ -87,7 +87,7 @@ impl DirEntry {
/// ``` /// ```
pub async fn metadata(&self) -> io::Result<Metadata> { pub async fn metadata(&self) -> io::Result<Metadata> {
let inner = self.0.clone(); let inner = self.0.clone();
blocking::spawn(move || inner.metadata()).await spawn_blocking(move || inner.metadata()).await
} }
/// Reads the file type for this entry. /// Reads the file type for this entry.
@ -125,7 +125,7 @@ impl DirEntry {
/// ``` /// ```
pub async fn file_type(&self) -> io::Result<FileType> { pub async fn file_type(&self) -> io::Result<FileType> {
let inner = self.0.clone(); let inner = self.0.clone();
blocking::spawn(move || inner.file_type()).await spawn_blocking(move || inner.file_type()).await
} }
/// Returns the bare name of this entry without the leading path. /// Returns the bare name of this entry without the leading path.
@ -158,6 +158,12 @@ impl fmt::Debug for DirEntry {
} }
} }
impl Clone for DirEntry {
fn clone(&self) -> Self {
DirEntry(self.0.clone())
}
}
cfg_unix! { cfg_unix! {
use crate::os::unix::fs::DirEntryExt; use crate::os::unix::fs::DirEntryExt;

@ -12,7 +12,8 @@ use crate::future;
use crate::io::{self, Read, Seek, SeekFrom, Write}; use crate::io::{self, Read, Seek, SeekFrom, Write};
use crate::path::Path; use crate::path::Path;
use crate::prelude::*; use crate::prelude::*;
use crate::task::{self, blocking, Context, Poll, Waker}; use crate::task::{spawn_blocking, Context, Poll, Waker};
use crate::utils::Context as _;
/// An open file on the filesystem. /// An open file on the filesystem.
/// ///
@ -112,7 +113,10 @@ impl File {
/// ``` /// ```
pub async fn open<P: AsRef<Path>>(path: P) -> io::Result<File> { pub async fn open<P: AsRef<Path>>(path: P) -> io::Result<File> {
let path = path.as_ref().to_owned(); let path = path.as_ref().to_owned();
let file = blocking::spawn(move || std::fs::File::open(&path)).await?; let file = spawn_blocking(move || {
std::fs::File::open(&path).context(|| format!("could not open `{}`", path.display()))
})
.await?;
Ok(File::new(file, true)) Ok(File::new(file, true))
} }
@ -147,7 +151,11 @@ impl File {
/// ``` /// ```
pub async fn create<P: AsRef<Path>>(path: P) -> io::Result<File> { pub async fn create<P: AsRef<Path>>(path: P) -> io::Result<File> {
let path = path.as_ref().to_owned(); let path = path.as_ref().to_owned();
let file = blocking::spawn(move || std::fs::File::create(&path)).await?; let file = spawn_blocking(move || {
std::fs::File::create(&path)
.context(|| format!("could not create `{}`", path.display()))
})
.await?;
Ok(File::new(file, true)) Ok(File::new(file, true))
} }
@ -180,7 +188,7 @@ impl File {
}) })
.await?; .await?;
blocking::spawn(move || state.file.sync_all()).await spawn_blocking(move || state.file.sync_all()).await
} }
/// Synchronizes OS-internal buffered contents to disk. /// Synchronizes OS-internal buffered contents to disk.
@ -216,7 +224,7 @@ impl File {
}) })
.await?; .await?;
blocking::spawn(move || state.file.sync_data()).await spawn_blocking(move || state.file.sync_data()).await
} }
/// Truncates or extends the file. /// Truncates or extends the file.
@ -249,7 +257,7 @@ impl File {
}) })
.await?; .await?;
blocking::spawn(move || state.file.set_len(size)).await spawn_blocking(move || state.file.set_len(size)).await
} }
/// Reads the file's metadata. /// Reads the file's metadata.
@ -268,7 +276,7 @@ impl File {
/// ``` /// ```
pub async fn metadata(&self) -> io::Result<Metadata> { pub async fn metadata(&self) -> io::Result<Metadata> {
let file = self.file.clone(); let file = self.file.clone();
blocking::spawn(move || file.metadata()).await spawn_blocking(move || file.metadata()).await
} }
/// Changes the permissions on the file. /// Changes the permissions on the file.
@ -297,7 +305,7 @@ impl File {
/// ``` /// ```
pub async fn set_permissions(&self, perm: Permissions) -> io::Result<()> { pub async fn set_permissions(&self, perm: Permissions) -> io::Result<()> {
let file = self.file.clone(); let file = self.file.clone();
blocking::spawn(move || file.set_permissions(perm)).await spawn_blocking(move || file.set_permissions(perm)).await
} }
} }
@ -307,7 +315,7 @@ impl Drop for File {
// non-blocking fashion, but our only other option here is losing data remaining in the // non-blocking fashion, but our only other option here is losing data remaining in the
// write cache. Good task schedulers should be resilient to occasional blocking hiccups in // write cache. Good task schedulers should be resilient to occasional blocking hiccups in
// file destructors so we don't expect this to be a common problem in practice. // file destructors so we don't expect this to be a common problem in practice.
let _ = task::block_on(self.flush()); let _ = smol::block_on(self.flush());
} }
} }
@ -665,7 +673,7 @@ impl LockGuard<State> {
if available > 0 || self.cache.is_empty() { if available > 0 || self.cache.is_empty() {
// Copy data from the cache into the buffer. // Copy data from the cache into the buffer.
let n = cmp::min(available, buf.len()); let n = cmp::min(available, buf.len());
buf[..n].copy_from_slice(&self.cache[start..n]); buf[..n].copy_from_slice(&self.cache[start..(start + n)]);
// Move the read cursor forward. // Move the read cursor forward.
self.mode = Mode::Reading(start + n); self.mode = Mode::Reading(start + n);
@ -692,7 +700,7 @@ impl LockGuard<State> {
self.register(cx); self.register(cx);
// Start a read operation asynchronously. // Start a read operation asynchronously.
blocking::spawn(move || { spawn_blocking(move || {
// Read some data from the file into the cache. // Read some data from the file into the cache.
let res = { let res = {
let State { file, cache, .. } = &mut *self; let State { file, cache, .. } = &mut *self;
@ -733,7 +741,10 @@ impl LockGuard<State> {
if n > 0 { if n > 0 {
// Seek `n` bytes backwards. This call should not block because it only changes // Seek `n` bytes backwards. This call should not block because it only changes
// the internal offset into the file and doesn't touch the actual file on disk. // the internal offset into the file and doesn't touch the actual file on disk.
(&*self.file).seek(SeekFrom::Current(-(n as i64)))?; //
// We ignore errors here because special files like `/dev/random` are not
// seekable.
let _ = (&*self.file).seek(SeekFrom::Current(-(n as i64)));
} }
// Switch to idle mode. // Switch to idle mode.
@ -801,7 +812,7 @@ impl LockGuard<State> {
self.register(cx); self.register(cx);
// Start a write operation asynchronously. // Start a write operation asynchronously.
blocking::spawn(move || { spawn_blocking(move || {
match (&*self.file).write_all(&self.cache) { match (&*self.file).write_all(&self.cache) {
Ok(_) => { Ok(_) => {
// Switch to idle mode. // Switch to idle mode.
@ -834,7 +845,7 @@ impl LockGuard<State> {
self.register(cx); self.register(cx);
// Start a flush operation asynchronously. // Start a flush operation asynchronously.
blocking::spawn(move || { spawn_blocking(move || {
match (&*self.file).flush() { match (&*self.file).flush() {
Ok(()) => { Ok(()) => {
// Mark the file as flushed. // Mark the file as flushed.
@ -856,3 +867,15 @@ impl LockGuard<State> {
Poll::Ready(Ok(())) Poll::Ready(Ok(()))
} }
} }
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn async_file_drop() {
crate::task::block_on(async move {
File::open(file!()).await.unwrap();
});
}
}

@ -40,7 +40,7 @@ cfg_docs! {
/// # Ok(()) }) } /// # Ok(()) }) }
/// ``` /// ```
pub fn is_dir(&self) -> bool { pub fn is_dir(&self) -> bool {
unimplemented!() unreachable!("this impl only appears in the rendered docs")
} }
/// Returns `true` if this file type represents a regular file. /// Returns `true` if this file type represents a regular file.
@ -60,7 +60,7 @@ cfg_docs! {
/// # Ok(()) }) } /// # Ok(()) }) }
/// ``` /// ```
pub fn is_file(&self) -> bool { pub fn is_file(&self) -> bool {
unimplemented!() unreachable!("this impl only appears in the rendered docs")
} }
/// Returns `true` if this file type represents a symbolic link. /// Returns `true` if this file type represents a symbolic link.
@ -78,7 +78,7 @@ cfg_docs! {
/// # Ok(()) }) } /// # Ok(()) }) }
/// ``` /// ```
pub fn is_symlink(&self) -> bool { pub fn is_symlink(&self) -> bool {
unimplemented!() unreachable!("this impl only appears in the rendered docs")
} }
} }
} }

@ -1,6 +1,7 @@
use crate::io; use crate::io;
use crate::path::Path; use crate::path::Path;
use crate::task::blocking; use crate::task::spawn_blocking;
use crate::utils::Context as _;
/// Creates a hard link on the filesystem. /// Creates a hard link on the filesystem.
/// ///
@ -32,5 +33,14 @@ use crate::task::blocking;
pub async fn hard_link<P: AsRef<Path>, Q: AsRef<Path>>(from: P, to: Q) -> io::Result<()> { pub async fn hard_link<P: AsRef<Path>, Q: AsRef<Path>>(from: P, to: Q) -> io::Result<()> {
let from = from.as_ref().to_owned(); let from = from.as_ref().to_owned();
let to = to.as_ref().to_owned(); let to = to.as_ref().to_owned();
blocking::spawn(move || std::fs::hard_link(&from, &to)).await spawn_blocking(move || {
std::fs::hard_link(&from, &to).context(|| {
format!(
"could not create a hard link from `{}` to `{}`",
from.display(),
to.display()
)
})
})
.await
} }

@ -1,6 +1,6 @@
use crate::io; use crate::io;
use crate::path::Path; use crate::path::Path;
use crate::task::blocking; use crate::task::spawn_blocking;
/// Reads metadata for a path. /// Reads metadata for a path.
/// ///
@ -34,7 +34,7 @@ use crate::task::blocking;
/// ``` /// ```
pub async fn metadata<P: AsRef<Path>>(path: P) -> io::Result<Metadata> { pub async fn metadata<P: AsRef<Path>>(path: P) -> io::Result<Metadata> {
let path = path.as_ref().to_owned(); let path = path.as_ref().to_owned();
blocking::spawn(move || std::fs::metadata(path)).await spawn_blocking(move || std::fs::metadata(path)).await
} }
cfg_not_docs! { cfg_not_docs! {
@ -78,7 +78,7 @@ cfg_docs! {
/// # Ok(()) }) } /// # Ok(()) }) }
/// ``` /// ```
pub fn file_type(&self) -> FileType { pub fn file_type(&self) -> FileType {
unimplemented!() unreachable!("this impl only appears in the rendered docs")
} }
/// Returns `true` if this metadata is for a regular directory. /// Returns `true` if this metadata is for a regular directory.
@ -98,7 +98,7 @@ cfg_docs! {
/// # Ok(()) }) } /// # Ok(()) }) }
/// ``` /// ```
pub fn is_dir(&self) -> bool { pub fn is_dir(&self) -> bool {
unimplemented!() unreachable!("this impl only appears in the rendered docs")
} }
/// Returns `true` if this metadata is for a regular file. /// Returns `true` if this metadata is for a regular file.
@ -118,7 +118,7 @@ cfg_docs! {
/// # Ok(()) }) } /// # Ok(()) }) }
/// ``` /// ```
pub fn is_file(&self) -> bool { pub fn is_file(&self) -> bool {
unimplemented!() unreachable!("this impl only appears in the rendered docs")
} }
/// Returns the file size in bytes. /// Returns the file size in bytes.
@ -136,7 +136,7 @@ cfg_docs! {
/// # Ok(()) }) } /// # Ok(()) }) }
/// ``` /// ```
pub fn len(&self) -> u64 { pub fn len(&self) -> u64 {
unimplemented!() unreachable!("this impl only appears in the rendered docs")
} }
/// Returns the permissions from this metadata. /// Returns the permissions from this metadata.
@ -154,7 +154,7 @@ cfg_docs! {
/// # Ok(()) }) } /// # Ok(()) }) }
/// ``` /// ```
pub fn permissions(&self) -> Permissions { pub fn permissions(&self) -> Permissions {
unimplemented!() unreachable!("this impl only appears in the rendered docs")
} }
/// Returns the last modification time. /// Returns the last modification time.
@ -177,7 +177,7 @@ cfg_docs! {
/// # Ok(()) }) } /// # Ok(()) }) }
/// ``` /// ```
pub fn modified(&self) -> io::Result<SystemTime> { pub fn modified(&self) -> io::Result<SystemTime> {
unimplemented!() unreachable!("this impl only appears in the rendered docs")
} }
/// Returns the last access time. /// Returns the last access time.
@ -200,7 +200,7 @@ cfg_docs! {
/// # Ok(()) }) } /// # Ok(()) }) }
/// ``` /// ```
pub fn accessed(&self) -> io::Result<SystemTime> { pub fn accessed(&self) -> io::Result<SystemTime> {
unimplemented!() unreachable!("this impl only appears in the rendered docs")
} }
/// Returns the creation time. /// Returns the creation time.
@ -223,7 +223,7 @@ cfg_docs! {
/// # Ok(()) }) } /// # Ok(()) }) }
/// ``` /// ```
pub fn created(&self) -> io::Result<SystemTime> { pub fn created(&self) -> io::Result<SystemTime> {
unimplemented!() unreachable!("this impl only appears in the rendered docs")
} }
} }
} }

@ -3,11 +3,13 @@
//! This module is an async version of [`std::fs`]. //! This module is an async version of [`std::fs`].
//! //!
//! [`os::unix::fs`]: ../os/unix/fs/index.html //! [`os::unix::fs`]: ../os/unix/fs/index.html
//! [`os::windows::fs`]: ../os/windows/fs/index.html
//! [`std::fs`]: https://doc.rust-lang.org/std/fs/index.html //! [`std::fs`]: https://doc.rust-lang.org/std/fs/index.html
//! //!
//! # Platform-specific extensions //! # Platform-specific extensions
//! //!
//! * Unix: use the [`os::unix::fs`] module. //! * Unix: use the [`os::unix::fs`] module.
//! * Windows: use the [`os::windows::fs`] module.
//! //!
//! # Examples //! # Examples
//! //!

@ -3,7 +3,7 @@ use std::future::Future;
use crate::fs::File; use crate::fs::File;
use crate::io; use crate::io;
use crate::path::Path; use crate::path::Path;
use crate::task::blocking; use crate::task::spawn_blocking;
/// A builder for opening files with configurable options. /// A builder for opening files with configurable options.
/// ///
@ -285,7 +285,7 @@ impl OpenOptions {
let path = path.as_ref().to_owned(); let path = path.as_ref().to_owned();
let options = self.0.clone(); let options = self.0.clone();
async move { async move {
let file = blocking::spawn(move || options.open(path)).await?; let file = spawn_blocking(move || options.open(path)).await?;
Ok(File::new(file, true)) Ok(File::new(file, true))
} }
} }

@ -29,7 +29,7 @@ cfg_docs! {
/// # Ok(()) }) } /// # Ok(()) }) }
/// ``` /// ```
pub fn readonly(&self) -> bool { pub fn readonly(&self) -> bool {
unimplemented!() unreachable!("this impl only appears in the rendered docs")
} }
/// Configures the read-only flag. /// Configures the read-only flag.
@ -50,7 +50,7 @@ cfg_docs! {
/// # Ok(()) }) } /// # Ok(()) }) }
/// ``` /// ```
pub fn set_readonly(&mut self, readonly: bool) { pub fn set_readonly(&mut self, readonly: bool) {
unimplemented!() unreachable!("this impl only appears in the rendered docs")
} }
} }
} }

@ -1,6 +1,7 @@
use crate::io; use crate::io;
use crate::path::Path; use crate::path::Path;
use crate::task::blocking; use crate::task::spawn_blocking;
use crate::utils::Context as _;
/// Reads the entire contents of a file as raw bytes. /// Reads the entire contents of a file as raw bytes.
/// ///
@ -36,5 +37,8 @@ use crate::task::blocking;
/// ``` /// ```
pub async fn read<P: AsRef<Path>>(path: P) -> io::Result<Vec<u8>> { pub async fn read<P: AsRef<Path>>(path: P) -> io::Result<Vec<u8>> {
let path = path.as_ref().to_owned(); let path = path.as_ref().to_owned();
blocking::spawn(move || std::fs::read(path)).await spawn_blocking(move || {
std::fs::read(&path).context(|| format!("could not read file `{}`", path.display()))
})
.await
} }

@ -1,11 +1,12 @@
use std::future::Future;
use std::pin::Pin; use std::pin::Pin;
use crate::fs::DirEntry; use crate::fs::DirEntry;
use crate::future::Future;
use crate::io; use crate::io;
use crate::path::Path; use crate::path::Path;
use crate::stream::Stream; use crate::stream::Stream;
use crate::task::{blocking, Context, JoinHandle, Poll}; use crate::task::{spawn_blocking, Context, JoinHandle, Poll};
use crate::utils::Context as _;
/// Returns a stream of entries in a directory. /// Returns a stream of entries in a directory.
/// ///
@ -45,9 +46,12 @@ use crate::task::{blocking, Context, JoinHandle, Poll};
/// ``` /// ```
pub async fn read_dir<P: AsRef<Path>>(path: P) -> io::Result<ReadDir> { pub async fn read_dir<P: AsRef<Path>>(path: P) -> io::Result<ReadDir> {
let path = path.as_ref().to_owned(); let path = path.as_ref().to_owned();
blocking::spawn(move || std::fs::read_dir(path)) spawn_blocking(move || {
.await std::fs::read_dir(&path)
.map(ReadDir::new) .context(|| format!("could not read directory `{}`", path.display()))
})
.await
.map(ReadDir::new)
} }
/// A stream of entries in a directory. /// A stream of entries in a directory.
@ -91,7 +95,7 @@ impl Stream for ReadDir {
let mut inner = opt.take().unwrap(); let mut inner = opt.take().unwrap();
// Start the operation asynchronously. // Start the operation asynchronously.
self.0 = State::Busy(blocking::spawn(move || { self.0 = State::Busy(spawn_blocking(move || {
let next = inner.next(); let next = inner.next();
(inner, next) (inner, next)
})); }));

@ -1,6 +1,7 @@
use crate::io; use crate::io;
use crate::path::{Path, PathBuf}; use crate::path::{Path, PathBuf};
use crate::task::blocking; use crate::task::spawn_blocking;
use crate::utils::Context as _;
/// Reads a symbolic link and returns the path it points to. /// Reads a symbolic link and returns the path it points to.
/// ///
@ -28,5 +29,10 @@ use crate::task::blocking;
/// ``` /// ```
pub async fn read_link<P: AsRef<Path>>(path: P) -> io::Result<PathBuf> { pub async fn read_link<P: AsRef<Path>>(path: P) -> io::Result<PathBuf> {
let path = path.as_ref().to_owned(); let path = path.as_ref().to_owned();
blocking::spawn(move || std::fs::read_link(path).map(Into::into)).await spawn_blocking(move || {
std::fs::read_link(&path)
.map(Into::into)
.context(|| format!("could not read link `{}`", path.display()))
})
.await
} }

@ -1,6 +1,7 @@
use crate::io; use crate::io;
use crate::path::Path; use crate::path::Path;
use crate::task::blocking; use crate::task::spawn_blocking;
use crate::utils::Context as _;
/// Reads the entire contents of a file as a string. /// Reads the entire contents of a file as a string.
/// ///
@ -37,5 +38,9 @@ use crate::task::blocking;
/// ``` /// ```
pub async fn read_to_string<P: AsRef<Path>>(path: P) -> io::Result<String> { pub async fn read_to_string<P: AsRef<Path>>(path: P) -> io::Result<String> {
let path = path.as_ref().to_owned(); let path = path.as_ref().to_owned();
blocking::spawn(move || std::fs::read_to_string(path)).await spawn_blocking(move || {
std::fs::read_to_string(&path)
.context(|| format!("could not read file `{}`", path.display()))
})
.await
} }

@ -1,6 +1,7 @@
use crate::io; use crate::io;
use crate::path::Path; use crate::path::Path;
use crate::task::blocking; use crate::task::spawn_blocking;
use crate::utils::Context as _;
/// Removes an empty directory. /// Removes an empty directory.
/// ///
@ -29,5 +30,9 @@ use crate::task::blocking;
/// ``` /// ```
pub async fn remove_dir<P: AsRef<Path>>(path: P) -> io::Result<()> { pub async fn remove_dir<P: AsRef<Path>>(path: P) -> io::Result<()> {
let path = path.as_ref().to_owned(); let path = path.as_ref().to_owned();
blocking::spawn(move || std::fs::remove_dir(path)).await spawn_blocking(move || {
std::fs::remove_dir(&path)
.context(|| format!("could not remove directory `{}`", path.display()))
})
.await
} }

@ -1,6 +1,7 @@
use crate::io; use crate::io;
use crate::path::Path; use crate::path::Path;
use crate::task::blocking; use crate::task::spawn_blocking;
use crate::utils::Context as _;
/// Removes a directory and all of its contents. /// Removes a directory and all of its contents.
/// ///
@ -29,5 +30,9 @@ use crate::task::blocking;
/// ``` /// ```
pub async fn remove_dir_all<P: AsRef<Path>>(path: P) -> io::Result<()> { pub async fn remove_dir_all<P: AsRef<Path>>(path: P) -> io::Result<()> {
let path = path.as_ref().to_owned(); let path = path.as_ref().to_owned();
blocking::spawn(move || std::fs::remove_dir_all(path)).await spawn_blocking(move || {
std::fs::remove_dir_all(&path)
.context(|| format!("could not remove directory `{}`", path.display()))
})
.await
} }

@ -1,6 +1,7 @@
use crate::io; use crate::io;
use crate::path::Path; use crate::path::Path;
use crate::task::blocking; use crate::task::spawn_blocking;
use crate::utils::Context as _;
/// Removes a file. /// Removes a file.
/// ///
@ -29,5 +30,9 @@ use crate::task::blocking;
/// ``` /// ```
pub async fn remove_file<P: AsRef<Path>>(path: P) -> io::Result<()> { pub async fn remove_file<P: AsRef<Path>>(path: P) -> io::Result<()> {
let path = path.as_ref().to_owned(); let path = path.as_ref().to_owned();
blocking::spawn(move || std::fs::remove_file(path)).await spawn_blocking(move || {
std::fs::remove_file(&path)
.context(|| format!("could not remove file `{}`", path.display()))
})
.await
} }

@ -1,6 +1,7 @@
use crate::io; use crate::io;
use crate::path::Path; use crate::path::Path;
use crate::task::blocking; use crate::task::spawn_blocking;
use crate::utils::Context as _;
/// Renames a file or directory to a new location. /// Renames a file or directory to a new location.
/// ///
@ -34,5 +35,14 @@ use crate::task::blocking;
pub async fn rename<P: AsRef<Path>, Q: AsRef<Path>>(from: P, to: Q) -> io::Result<()> { pub async fn rename<P: AsRef<Path>, Q: AsRef<Path>>(from: P, to: Q) -> io::Result<()> {
let from = from.as_ref().to_owned(); let from = from.as_ref().to_owned();
let to = to.as_ref().to_owned(); let to = to.as_ref().to_owned();
blocking::spawn(move || std::fs::rename(&from, &to)).await spawn_blocking(move || {
std::fs::rename(&from, &to).context(|| {
format!(
"could not rename `{}` to `{}`",
from.display(),
to.display()
)
})
})
.await
} }

@ -1,7 +1,7 @@
use crate::fs::Permissions; use crate::fs::Permissions;
use crate::io; use crate::io;
use crate::path::Path; use crate::path::Path;
use crate::task::blocking; use crate::task::spawn_blocking;
/// Changes the permissions of a file or directory. /// Changes the permissions of a file or directory.
/// ///
@ -32,5 +32,5 @@ use crate::task::blocking;
/// ``` /// ```
pub async fn set_permissions<P: AsRef<Path>>(path: P, perm: Permissions) -> io::Result<()> { pub async fn set_permissions<P: AsRef<Path>>(path: P, perm: Permissions) -> io::Result<()> {
let path = path.as_ref().to_owned(); let path = path.as_ref().to_owned();
blocking::spawn(move || std::fs::set_permissions(path, perm)).await spawn_blocking(move || std::fs::set_permissions(path, perm)).await
} }

@ -1,7 +1,7 @@
use crate::fs::Metadata; use crate::fs::Metadata;
use crate::io; use crate::io;
use crate::path::Path; use crate::path::Path;
use crate::task::blocking; use crate::task::spawn_blocking;
/// Reads metadata for a path without following symbolic links. /// Reads metadata for a path without following symbolic links.
/// ///
@ -34,5 +34,5 @@ use crate::task::blocking;
/// ``` /// ```
pub async fn symlink_metadata<P: AsRef<Path>>(path: P) -> io::Result<Metadata> { pub async fn symlink_metadata<P: AsRef<Path>>(path: P) -> io::Result<Metadata> {
let path = path.as_ref().to_owned(); let path = path.as_ref().to_owned();
blocking::spawn(move || std::fs::symlink_metadata(path)).await spawn_blocking(move || std::fs::symlink_metadata(path)).await
} }

@ -1,6 +1,7 @@
use crate::io; use crate::io;
use crate::path::Path; use crate::path::Path;
use crate::task::blocking; use crate::task::spawn_blocking;
use crate::utils::Context as _;
/// Writes a slice of bytes as the new contents of a file. /// Writes a slice of bytes as the new contents of a file.
/// ///
@ -33,5 +34,9 @@ use crate::task::blocking;
pub async fn write<P: AsRef<Path>, C: AsRef<[u8]>>(path: P, contents: C) -> io::Result<()> { pub async fn write<P: AsRef<Path>, C: AsRef<[u8]>>(path: P, contents: C) -> io::Result<()> {
let path = path.as_ref().to_owned(); let path = path.as_ref().to_owned();
let contents = contents.as_ref().to_owned(); let contents = contents.as_ref().to_owned();
blocking::spawn(move || std::fs::write(path, contents)).await spawn_blocking(move || {
std::fs::write(&path, contents)
.context(|| format!("could not write to file `{}`", path.display()))
})
.await
} }

@ -1,169 +0,0 @@
cfg_unstable! {
mod delay;
use std::time::Duration;
use delay::DelayFuture;
}
extension_trait! {
use std::pin::Pin;
use std::ops::{Deref, DerefMut};
use crate::task::{Context, Poll};
#[doc = r#"
A future represents an asynchronous computation.
A future is a value that may not have finished computing yet. This kind of
"asynchronous value" makes it possible for a thread to continue doing useful
work while it waits for the value to become available.
# The `poll` method
The core method of future, `poll`, *attempts* to resolve the future into a
final value. This method does not block if the value is not ready. Instead,
the current task is scheduled to be woken up when it's possible to make
further progress by `poll`ing again. The `context` passed to the `poll`
method can provide a [`Waker`], which is a handle for waking up the current
task.
When using a future, you generally won't call `poll` directly, but instead
`.await` the value.
[`Waker`]: ../task/struct.Waker.html
"#]
pub trait Future {
#[doc = r#"
The type of value produced on completion.
"#]
type Output;
#[doc = r#"
Attempt to resolve the future to a final value, registering
the current task for wakeup if the value is not yet available.
# Return value
This function returns:
- [`Poll::Pending`] if the future is not ready yet
- [`Poll::Ready(val)`] with the result `val` of this future if it
finished successfully.
Once a future has finished, clients should not `poll` it again.
When a future is not ready yet, `poll` returns `Poll::Pending` and
stores a clone of the [`Waker`] copied from the current [`Context`].
This [`Waker`] is then woken once the future can make progress.
For example, a future waiting for a socket to become
readable would call `.clone()` on the [`Waker`] and store it.
When a signal arrives elsewhere indicating that the socket is readable,
[`Waker::wake`] is called and the socket future's task is awoken.
Once a task has been woken up, it should attempt to `poll` the future
again, which may or may not produce a final value.
Note that on multiple calls to `poll`, only the [`Waker`] from the
[`Context`] passed to the most recent call should be scheduled to
receive a wakeup.
# Runtime characteristics
Futures alone are *inert*; they must be *actively* `poll`ed to make
progress, meaning that each time the current task is woken up, it should
actively re-`poll` pending futures that it still has an interest in.
The `poll` function is not called repeatedly in a tight loop -- instead,
it should only be called when the future indicates that it is ready to
make progress (by calling `wake()`). If you're familiar with the
`poll(2)` or `select(2)` syscalls on Unix it's worth noting that futures
typically do *not* suffer the same problems of "all wakeups must poll
all events"; they are more like `epoll(4)`.
An implementation of `poll` should strive to return quickly, and should
not block. Returning quickly prevents unnecessarily clogging up
threads or event loops. If it is known ahead of time that a call to
`poll` may end up taking awhile, the work should be offloaded to a
thread pool (or something similar) to ensure that `poll` can return
quickly.
# Panics
Once a future has completed (returned `Ready` from `poll`), calling its
`poll` method again may panic, block forever, or cause other kinds of
problems; the `Future` trait places no requirements on the effects of
such a call. However, as the `poll` method is not marked `unsafe`,
Rust's usual rules apply: calls must never cause undefined behavior
(memory corruption, incorrect use of `unsafe` functions, or the like),
regardless of the future's state.
[`Poll::Pending`]: ../task/enum.Poll.html#variant.Pending
[`Poll::Ready(val)`]: ../task/enum.Poll.html#variant.Ready
[`Context`]: ../task/struct.Context.html
[`Waker`]: ../task/struct.Waker.html
[`Waker::wake`]: ../task/struct.Waker.html#method.wake
"#]
fn poll(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Self::Output>;
}
pub trait FutureExt: std::future::Future {
/// Returns a Future that delays execution for a specified time.
///
/// # Examples
///
/// ```
/// # async_std::task::block_on(async {
/// use async_std::prelude::*;
/// use async_std::future;
/// use std::time::Duration;
///
/// let a = future::ready(1).delay(Duration::from_millis(2000));
/// dbg!(a.await);
/// # })
/// ```
#[cfg_attr(feature = "docs", doc(cfg(unstable)))]
#[cfg(any(feature = "unstable", feature = "docs"))]
fn delay(self, dur: Duration) -> impl Future<Output = Self::Output> [DelayFuture<Self>]
where
Self: Future + Sized
{
DelayFuture::new(self, dur)
}
}
impl<F: Future + Unpin + ?Sized> Future for Box<F> {
type Output = F::Output;
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
unreachable!("this impl only appears in the rendered docs")
}
}
impl<F: Future + Unpin + ?Sized> Future for &mut F {
type Output = F::Output;
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
unreachable!("this impl only appears in the rendered docs")
}
}
impl<P> Future for Pin<P>
where
P: DerefMut + Unpin,
<P as Deref>::Target: Future,
{
type Output = <<P as Deref>::Target as Future>::Output;
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
unreachable!("this impl only appears in the rendered docs")
}
}
impl<F: Future> Future for std::panic::AssertUnwindSafe<F> {
type Output = F::Output;
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
unreachable!("this impl only appears in the rendered docs")
}
}
}

@ -1,26 +1,26 @@
use std::future::Future;
use std::pin::Pin; use std::pin::Pin;
use std::time::Duration; use std::time::Duration;
use futures_timer::Delay;
use pin_project_lite::pin_project; use pin_project_lite::pin_project;
use crate::future::Future;
use crate::task::{Context, Poll}; use crate::task::{Context, Poll};
use crate::utils::{timer_after, Timer};
pin_project! { pin_project! {
#[doc(hidden)] #[doc(hidden)]
#[derive(Debug)] #[allow(missing_debug_implementations)]
pub struct DelayFuture<F> { pub struct DelayFuture<F> {
#[pin] #[pin]
future: F, future: F,
#[pin] #[pin]
delay: Delay, delay: Timer,
} }
} }
impl<F> DelayFuture<F> { impl<F> DelayFuture<F> {
pub fn new(future: F, dur: Duration) -> DelayFuture<F> { pub fn new(future: F, dur: Duration) -> DelayFuture<F> {
let delay = Delay::new(dur); let delay = timer_after(dur);
DelayFuture { future, delay } DelayFuture { future, delay }
} }

@ -0,0 +1,52 @@
use std::future::Future;
use std::pin::Pin;
use crate::future::IntoFuture;
use crate::task::{ready, Context, Poll};
#[doc(hidden)]
#[allow(missing_debug_implementations)]
pub struct FlattenFuture<Fut1, Fut2> {
state: State<Fut1, Fut2>,
}
#[derive(Debug)]
enum State<Fut1, Fut2> {
First(Fut1),
Second(Fut2),
Empty,
}
impl<Fut1, Fut2> FlattenFuture<Fut1, Fut2> {
pub(crate) fn new(future: Fut1) -> FlattenFuture<Fut1, Fut2> {
FlattenFuture {
state: State::First(future),
}
}
}
impl<Fut1> Future for FlattenFuture<Fut1, <Fut1::Output as IntoFuture>::Future>
where
Fut1: Future,
Fut1::Output: IntoFuture,
{
type Output = <Fut1::Output as IntoFuture>::Output;
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
let Self { state } = unsafe { self.get_unchecked_mut() };
loop {
match state {
State::First(fut1) => {
let fut2 = ready!(unsafe { Pin::new_unchecked(fut1) }.poll(cx)).into_future();
*state = State::Second(fut2);
}
State::Second(fut2) => {
let v = ready!(unsafe { Pin::new_unchecked(fut2) }.poll(cx));
*state = State::Empty;
return Poll::Ready(v);
}
State::Empty => panic!("polled a completed future"),
}
}
}
}

@ -0,0 +1,60 @@
use std::pin::Pin;
use crate::future::MaybeDone;
use pin_project_lite::pin_project;
use crate::task::{Context, Poll};
use std::future::Future;
pin_project! {
#[allow(missing_docs)]
#[allow(missing_debug_implementations)]
pub struct Join<L, R>
where
L: Future,
R: Future,
{
#[pin] left: MaybeDone<L>,
#[pin] right: MaybeDone<R>,
}
}
impl<L, R> Join<L, R>
where
L: Future,
R: Future,
{
pub(crate) fn new(left: L, right: R) -> Self {
Self {
left: MaybeDone::new(left),
right: MaybeDone::new(right),
}
}
}
impl<L, R> Future for Join<L, R>
where
L: Future,
R: Future,
{
type Output = (L::Output, R::Output);
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
let this = self.project();
let mut left = this.left;
let mut right = this.right;
let is_left_ready = Future::poll(Pin::new(&mut left), cx).is_ready();
if is_left_ready && right.as_ref().output().is_some() {
return Poll::Ready((left.take().unwrap(), right.take().unwrap()));
}
let is_right_ready = Future::poll(Pin::new(&mut right), cx).is_ready();
if is_right_ready && left.as_ref().output().is_some() {
return Poll::Ready((left.take().unwrap(), right.take().unwrap()));
}
Poll::Pending
}
}

@ -0,0 +1,432 @@
cfg_unstable! {
mod delay;
mod flatten;
mod race;
mod try_race;
mod join;
mod try_join;
use std::time::Duration;
use delay::DelayFuture;
use flatten::FlattenFuture;
use crate::future::IntoFuture;
use race::Race;
use try_race::TryRace;
use join::Join;
use try_join::TryJoin;
}
cfg_unstable_default! {
use crate::future::timeout::TimeoutFuture;
}
extension_trait! {
use core::pin::Pin;
use core::ops::{Deref, DerefMut};
use crate::task::{Context, Poll};
#[doc = r#"
A future represents an asynchronous computation.
A future is a value that may not have finished computing yet. This kind of
"asynchronous value" makes it possible for a thread to continue doing useful
work while it waits for the value to become available.
The [provided methods] do not really exist in the trait itself, but they become
available when [`FutureExt`] from the [prelude] is imported:
```
# #[allow(unused_imports)]
use async_std::prelude::*;
```
# The `poll` method
The core method of future, `poll`, *attempts* to resolve the future into a
final value. This method does not block if the value is not ready. Instead,
the current task is scheduled to be woken up when it's possible to make
further progress by `poll`ing again. The `context` passed to the `poll`
method can provide a [`Waker`], which is a handle for waking up the current
task.
When using a future, you generally won't call `poll` directly, but instead
`.await` the value.
[`Waker`]: ../task/struct.Waker.html
[provided methods]: #provided-methods
[`FutureExt`]: ../prelude/trait.FutureExt.html
[prelude]: ../prelude/index.html
"#]
pub trait Future {
#[doc = r#"
The type of value produced on completion.
"#]
type Output;
#[doc = r#"
Attempt to resolve the future to a final value, registering
the current task for wakeup if the value is not yet available.
# Return value
This function returns:
- [`Poll::Pending`] if the future is not ready yet
- [`Poll::Ready(val)`] with the result `val` of this future if it
finished successfully.
Once a future has finished, clients should not `poll` it again.
When a future is not ready yet, `poll` returns `Poll::Pending` and
stores a clone of the [`Waker`] copied from the current [`Context`].
This [`Waker`] is then woken once the future can make progress.
For example, a future waiting for a socket to become
readable would call `.clone()` on the [`Waker`] and store it.
When a signal arrives elsewhere indicating that the socket is readable,
[`Waker::wake`] is called and the socket future's task is awoken.
Once a task has been woken up, it should attempt to `poll` the future
again, which may or may not produce a final value.
Note that on multiple calls to `poll`, only the [`Waker`] from the
[`Context`] passed to the most recent call should be scheduled to
receive a wakeup.
# Runtime characteristics
Futures alone are *inert*; they must be *actively* `poll`ed to make
progress, meaning that each time the current task is woken up, it should
actively re-`poll` pending futures that it still has an interest in.
The `poll` function is not called repeatedly in a tight loop -- instead,
it should only be called when the future indicates that it is ready to
make progress (by calling `wake()`). If you're familiar with the
`poll(2)` or `select(2)` syscalls on Unix it's worth noting that futures
typically do *not* suffer the same problems of "all wakeups must poll
all events"; they are more like `epoll(4)`.
An implementation of `poll` should strive to return quickly, and should
not block. Returning quickly prevents unnecessarily clogging up
threads or event loops. If it is known ahead of time that a call to
`poll` may end up taking awhile, the work should be offloaded to a
thread pool (or something similar) to ensure that `poll` can return
quickly.
# Panics
Once a future has completed (returned `Ready` from `poll`), calling its
`poll` method again may panic, block forever, or cause other kinds of
problems; the `Future` trait places no requirements on the effects of
such a call. However, as the `poll` method is not marked `unsafe`,
Rust's usual rules apply: calls must never cause undefined behavior
(memory corruption, incorrect use of `unsafe` functions, or the like),
regardless of the future's state.
[`Poll::Pending`]: ../task/enum.Poll.html#variant.Pending
[`Poll::Ready(val)`]: ../task/enum.Poll.html#variant.Ready
[`Context`]: ../task/struct.Context.html
[`Waker`]: ../task/struct.Waker.html
[`Waker::wake`]: ../task/struct.Waker.html#method.wake
"#]
fn poll(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Self::Output>;
}
#[doc = r#"
Extension methods for [`Future`].
[`Future`]: ../future/trait.Future.html
"#]
pub trait FutureExt: core::future::Future {
/// Returns a Future that delays execution for a specified time.
///
/// # Examples
///
/// ```
/// # async_std::task::block_on(async {
/// use async_std::prelude::*;
/// use async_std::future;
/// use std::time::Duration;
///
/// let a = future::ready(1).delay(Duration::from_millis(2000));
/// dbg!(a.await);
/// # })
/// ```
#[cfg(feature = "unstable")]
#[cfg_attr(feature = "docs", doc(cfg(unstable)))]
fn delay(self, dur: Duration) -> impl Future<Output = Self::Output> [DelayFuture<Self>]
where
Self: Sized,
{
DelayFuture::new(self, dur)
}
/// Flatten out the execution of this future when the result itself
/// can be converted into another future.
///
/// # Examples
///
/// ```
/// # async_std::task::block_on(async {
/// use async_std::prelude::*;
///
/// let nested_future = async { async { 1 } };
/// let future = nested_future.flatten();
/// assert_eq!(future.await, 1);
/// # })
/// ```
#[cfg(feature = "unstable")]
#[cfg_attr(feature = "docs", doc(cfg(unstable)))]
fn flatten(
self,
) -> impl Future<Output = <Self::Output as IntoFuture>::Output>
[FlattenFuture<Self, <Self::Output as IntoFuture>::Future>]
where
Self: Sized,
<Self as Future>::Output: IntoFuture,
{
FlattenFuture::new(self)
}
#[doc = r#"
Waits for one of two similarly-typed futures to complete.
Awaits multiple futures simultaneously, returning the output of the
first future that completes.
This function will return a new future which awaits for either one of both
futures to complete. If multiple futures are completed at the same time,
resolution will occur in the order that they have been passed.
Note that this function consumes all futures passed, and once a future is
completed, all other futures are dropped.
# Examples
```
# async_std::task::block_on(async {
use async_std::prelude::*;
use async_std::future;
let a = future::pending();
let b = future::ready(1u8);
let c = future::ready(2u8);
let f = a.race(b).race(c);
assert_eq!(f.await, 1u8);
# });
```
"#]
#[cfg(feature = "unstable")]
#[cfg_attr(feature = "docs", doc(cfg(unstable)))]
fn race<F>(
self,
other: F,
) -> impl Future<Output = <Self as std::future::Future>::Output> [Race<Self, F>]
where
Self: std::future::Future + Sized,
F: std::future::Future<Output = <Self as std::future::Future>::Output>,
{
Race::new(self, other)
}
#[doc = r#"
Waits for one of two similarly-typed fallible futures to complete.
Awaits multiple futures simultaneously, returning all results once complete.
`try_race` is similar to [`race`], but keeps going if a future
resolved to an error until all futures have been resolved. In which case
an error is returned.
The ordering of which value is yielded when two futures resolve
simultaneously is intentionally left unspecified.
[`race`]: #method.race
# Examples
```
# fn main() -> std::io::Result<()> { async_std::task::block_on(async {
#
use async_std::prelude::*;
use async_std::future;
use std::io::{Error, ErrorKind};
let a = future::pending::<Result<_, Error>>();
let b = future::ready(Err(Error::from(ErrorKind::Other)));
let c = future::ready(Ok(1u8));
let f = a.try_race(b).try_race(c);
assert_eq!(f.await?, 1u8);
#
# Ok(()) }) }
```
"#]
#[cfg(feature = "unstable")]
#[cfg_attr(feature = "docs", doc(cfg(unstable)))]
fn try_race<F, T, E>(
self,
other: F
) -> impl Future<Output = <Self as std::future::Future>::Output> [TryRace<Self, F>]
where
Self: std::future::Future<Output = Result<T, E>> + Sized,
F: std::future::Future<Output = <Self as std::future::Future>::Output>,
{
TryRace::new(self, other)
}
#[doc = r#"
Waits for two similarly-typed futures to complete.
Awaits multiple futures simultaneously, returning the output of the
futures once both complete.
This function returns a new future which polls both futures
concurrently.
# Examples
```
# async_std::task::block_on(async {
use async_std::prelude::*;
use async_std::future;
let a = future::ready(1u8);
let b = future::ready(2u16);
let f = a.join(b);
assert_eq!(f.await, (1u8, 2u16));
# });
```
"#]
#[cfg(any(feature = "unstable", feature = "docs"))]
#[cfg_attr(feature = "docs", doc(cfg(unstable)))]
fn join<F>(
self,
other: F
) -> impl Future<Output = (<Self as std::future::Future>::Output, <F as std::future::Future>::Output)> [Join<Self, F>]
where
Self: std::future::Future + Sized,
F: std::future::Future,
{
Join::new(self, other)
}
#[doc = r#"
Waits for two similarly-typed fallible futures to complete.
Awaits multiple futures simultaneously, returning all results once
complete.
`try_join` is similar to [`join`], but returns an error immediately
if a future resolves to an error.
[`join`]: #method.join
# Examples
```
# fn main() -> std::io::Result<()> { async_std::task::block_on(async {
#
use async_std::prelude::*;
use async_std::future;
let a = future::ready(Err::<u8, &str>("Error"));
let b = future::ready(Ok(1u8));
let f = a.try_join(b);
assert_eq!(f.await, Err("Error"));
let a = future::ready(Ok::<u8, String>(1u8));
let b = future::ready(Ok::<u16, String>(2u16));
let f = a.try_join(b);
assert_eq!(f.await, Ok((1u8, 2u16)));
#
# Ok(()) }) }
```
"#]
#[cfg(any(feature = "unstable", feature = "docs"))]
#[cfg_attr(feature = "docs", doc(cfg(unstable)))]
fn try_join<F, A, B, E>(
self,
other: F
) -> impl Future<Output = Result<(A, B), E>> [TryJoin<Self, F>]
where
Self: std::future::Future<Output = Result<A, E>> + Sized,
F: std::future::Future<Output = Result<B, E>>,
{
TryJoin::new(self, other)
}
#[doc = r#"
Waits for both the future and a timeout, if the timeout completes before
the future, it returns an TimeoutError.
# Example
```
# async_std::task::block_on(async {
#
use std::time::Duration;
use async_std::prelude::*;
use async_std::future;
let fut = future::ready(0);
let dur = Duration::from_millis(100);
let res = fut.timeout(dur).await;
assert!(res.is_ok());
let fut = future::pending::<()>();
let dur = Duration::from_millis(100);
let res = fut.timeout(dur).await;
assert!(res.is_err())
#
# });
```
"#]
#[cfg(any(all(feature = "default", feature = "unstable"), feature = "docs"))]
#[cfg_attr(feature = "docs", doc(cfg(unstable)))]
fn timeout(self, dur: Duration) -> impl Future<Output = Self::Output> [TimeoutFuture<Self>]
where Self: Sized
{
TimeoutFuture::new(self, dur)
}
}
impl<F: Future + Unpin + ?Sized> Future for Box<F> {
type Output = F::Output;
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
unreachable!("this impl only appears in the rendered docs")
}
}
impl<F: Future + Unpin + ?Sized> Future for &mut F {
type Output = F::Output;
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
unreachable!("this impl only appears in the rendered docs")
}
}
impl<P> Future for Pin<P>
where
P: DerefMut + Unpin,
<P as Deref>::Target: Future,
{
type Output = <<P as Deref>::Target as Future>::Output;
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
unreachable!("this impl only appears in the rendered docs")
}
}
impl<F: Future> Future for std::panic::AssertUnwindSafe<F> {
type Output = F::Output;
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
unreachable!("this impl only appears in the rendered docs")
}
}
}

@ -0,0 +1,57 @@
use std::future::Future;
use std::pin::Pin;
use crate::future::MaybeDone;
use pin_project_lite::pin_project;
use crate::task::{Context, Poll};
pin_project! {
#[allow(missing_docs)]
#[allow(missing_debug_implementations)]
pub struct Race<L, R>
where
L: Future,
R: Future<Output = L::Output>
{
#[pin] left: MaybeDone<L>,
#[pin] right: MaybeDone<R>,
}
}
impl<L, R> Race<L, R>
where
L: Future,
R: Future<Output = L::Output>,
{
pub(crate) fn new(left: L, right: R) -> Self {
Self {
left: MaybeDone::new(left),
right: MaybeDone::new(right),
}
}
}
impl<L, R> Future for Race<L, R>
where
L: Future,
R: Future<Output = L::Output>,
{
type Output = L::Output;
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
let this = self.project();
let mut left = this.left;
if Future::poll(Pin::new(&mut left), cx).is_ready() {
return Poll::Ready(left.take().unwrap());
}
let mut right = this.right;
if Future::poll(Pin::new(&mut right), cx).is_ready() {
return Poll::Ready(right.take().unwrap());
}
Poll::Pending
}
}

@ -0,0 +1,72 @@
use std::pin::Pin;
use crate::future::MaybeDone;
use pin_project_lite::pin_project;
use crate::task::{Context, Poll};
use std::future::Future;
pin_project! {
#[allow(missing_docs)]
#[allow(missing_debug_implementations)]
pub struct TryJoin<L, R>
where
L: Future,
R: Future,
{
#[pin] left: MaybeDone<L>,
#[pin] right: MaybeDone<R>,
}
}
impl<L, R> TryJoin<L, R>
where
L: Future,
R: Future,
{
pub(crate) fn new(left: L, right: R) -> Self {
Self {
left: MaybeDone::new(left),
right: MaybeDone::new(right),
}
}
}
impl<L, R, A, B, E> Future for TryJoin<L, R>
where
L: Future<Output = Result<A, E>>,
R: Future<Output = Result<B, E>>,
{
type Output = Result<(A, B), E>;
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
let this = self.project();
let mut left = this.left;
let mut right = this.right;
if Future::poll(Pin::new(&mut left), cx).is_ready() {
if left.as_ref().output().unwrap().is_err() {
return Poll::Ready(Err(left.take().unwrap().err().unwrap()));
} else if right.as_ref().output().is_some() {
return Poll::Ready(Ok((
left.take().unwrap().ok().unwrap(),
right.take().unwrap().ok().unwrap(),
)));
}
}
if Future::poll(Pin::new(&mut right), cx).is_ready() {
if right.as_ref().output().unwrap().is_err() {
return Poll::Ready(Err(right.take().unwrap().err().unwrap()));
} else if left.as_ref().output().is_some() {
return Poll::Ready(Ok((
left.take().unwrap().ok().unwrap(),
right.take().unwrap().ok().unwrap(),
)));
}
}
Poll::Pending
}
}

@ -0,0 +1,66 @@
use std::pin::Pin;
use crate::future::MaybeDone;
use pin_project_lite::pin_project;
use crate::task::{Context, Poll};
use std::future::Future;
pin_project! {
#[allow(missing_docs)]
#[allow(missing_debug_implementations)]
pub struct TryRace<L, R>
where
L: Future,
R: Future<Output = L::Output>
{
#[pin] left: MaybeDone<L>,
#[pin] right: MaybeDone<R>,
}
}
impl<L, R> TryRace<L, R>
where
L: Future,
R: Future<Output = L::Output>,
{
pub(crate) fn new(left: L, right: R) -> Self {
Self {
left: MaybeDone::new(left),
right: MaybeDone::new(right),
}
}
}
impl<L, R, T, E> Future for TryRace<L, R>
where
L: Future<Output = Result<T, E>>,
R: Future<Output = L::Output>,
{
type Output = L::Output;
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
let this = self.project();
let mut left_errored = false;
// Check if the left future is ready & successful. Continue if not.
let mut left = this.left;
if Future::poll(Pin::new(&mut left), cx).is_ready() {
if left.as_ref().output().unwrap().is_ok() {
return Poll::Ready(left.take().unwrap());
} else {
left_errored = true;
}
}
// Check if the right future is ready & successful. Return err if left
// future also resolved to err. Continue if not.
let mut right = this.right;
let is_ready = Future::poll(Pin::new(&mut right), cx).is_ready();
if is_ready && (right.as_ref().output().unwrap().is_ok() || left_errored) {
return Poll::Ready(right.take().unwrap());
}
Poll::Pending
}
}

@ -1,4 +1,4 @@
use crate::future::Future; use std::future::Future;
/// Convert a type into a `Future`. /// Convert a type into a `Future`.
/// ///
@ -45,7 +45,6 @@ pub trait IntoFuture {
impl<T: Future> IntoFuture for T { impl<T: Future> IntoFuture for T {
type Output = T::Output; type Output = T::Output;
type Future = T; type Future = T;
fn into_future(self) -> Self::Future { fn into_future(self) -> Self::Future {

@ -0,0 +1,79 @@
//! A type that wraps a future to keep track of its completion status.
//!
//! This implementation was taken from the original `macro_rules` `join/try_join`
//! macros in the `futures-preview` crate.
use std::future::Future;
use std::mem;
use std::pin::Pin;
use std::task::{Context, Poll};
use futures_core::ready;
/// A future that may have completed.
#[derive(Debug)]
pub(crate) enum MaybeDone<Fut: Future> {
/// A not-yet-completed future
Future(Fut),
/// The output of the completed future
Done(Fut::Output),
/// The empty variant after the result of a [`MaybeDone`] has been
/// taken using the [`take`](MaybeDone::take) method.
Gone,
}
impl<Fut: Future> MaybeDone<Fut> {
/// Create a new instance of `MaybeDone`.
pub(crate) fn new(future: Fut) -> MaybeDone<Fut> {
Self::Future(future)
}
/// Returns an [`Option`] containing a reference to the output of the future.
/// The output of this method will be [`Some`] if and only if the inner
/// future has been completed and [`take`](MaybeDone::take)
/// has not yet been called.
#[inline]
pub(crate) fn output(self: Pin<&Self>) -> Option<&Fut::Output> {
let this = self.get_ref();
match this {
MaybeDone::Done(res) => Some(res),
_ => None,
}
}
/// Attempt to take the output of a `MaybeDone` without driving it
/// towards completion.
#[inline]
pub(crate) fn take(self: Pin<&mut Self>) -> Option<Fut::Output> {
unsafe {
let this = self.get_unchecked_mut();
match this {
MaybeDone::Done(_) => {}
MaybeDone::Future(_) | MaybeDone::Gone => return None,
};
if let MaybeDone::Done(output) = mem::replace(this, MaybeDone::Gone) {
Some(output)
} else {
unreachable!()
}
}
}
}
impl<Fut: Future> Future for MaybeDone<Fut> {
type Output = ();
fn poll(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
let res = unsafe {
match Pin::as_mut(&mut self).get_unchecked_mut() {
MaybeDone::Future(a) => ready!(Pin::new_unchecked(a).poll(cx)),
MaybeDone::Done(_) => return Poll::Ready(()),
MaybeDone::Gone => panic!("MaybeDone polled after value taken"),
}
};
self.set(MaybeDone::Done(res));
Poll::Ready(())
}
}

@ -4,62 +4,71 @@
//! //!
//! Often it's desireable to await multiple futures as if it was a single //! Often it's desireable to await multiple futures as if it was a single
//! future. The `join` family of operations converts multiple futures into a //! future. The `join` family of operations converts multiple futures into a
//! single future that returns all of their outputs. The `select` family of //! single future that returns all of their outputs. The `race` family of
//! operations converts multiple future into a single future that returns the //! operations converts multiple future into a single future that returns the
//! first output. //! first output.
//! //!
//! For operating on futures the following macros can be used: //! For operating on futures the following functions can be used:
//! //!
//! | Name | Return signature | When does it return? | //! | Name | Return signature | When does it return? |
//! | --- | --- | --- | //! | --- | --- | --- |
//! | `future::join` | `(T1, T2)` | Wait for all to complete //! | [`Future::join`] | `(T1, T2)` | Wait for all to complete
//! | `future::select` | `T` | Return on first value //! | [`Future::race`] | `T` | Return on first value
//! //!
//! ## Fallible Futures Concurrency //! ## Fallible Futures Concurrency
//! //!
//! For operating on futures that return `Result` additional `try_` variants of //! For operating on futures that return `Result` additional `try_` variants of
//! the macros mentioned before can be used. These macros are aware of `Result`, //! the functions mentioned before can be used. These functions are aware of `Result`,
//! and will behave slightly differently from their base variants. //! and will behave slightly differently from their base variants.
//! //!
//! In the case of `try_join`, if any of the futures returns `Err` all //! In the case of `try_join`, if any of the futures returns `Err` all
//! futures are dropped and an error is returned. This is referred to as //! futures are dropped and an error is returned. This is referred to as
//! "short-circuiting". //! "short-circuiting".
//! //!
//! In the case of `try_select`, instead of returning the first future that //! In the case of `try_race`, instead of returning the first future that
//! completes it returns the first future that _successfully_ completes. This //! completes it returns the first future that _successfully_ completes. This
//! means `try_select` will keep going until any one of the futures returns //! means `try_race` will keep going until any one of the futures returns
//! `Ok`, or _all_ futures have returned `Err`. //! `Ok`, or _all_ futures have returned `Err`.
//! //!
//! However sometimes it can be useful to use the base variants of the macros //! However sometimes it can be useful to use the base variants of the functions
//! even on futures that return `Result`. Here is an overview of operations that //! even on futures that return `Result`. Here is an overview of operations that
//! work on `Result`, and their respective semantics: //! work on `Result`, and their respective semantics:
//! //!
//! | Name | Return signature | When does it return? | //! | Name | Return signature | When does it return? |
//! | --- | --- | --- | //! | --- | --- | --- |
//! | `future::join` | `(Result<T, E>, Result<T, E>)` | Wait for all to complete //! | [`Future::join`] | `(Result<T, E>, Result<T, E>)` | Wait for all to complete
//! | `future::try_join` | `Result<(T1, T2), E>` | Return on first `Err`, wait for all to complete //! | [`Future::try_join`] | `Result<(T1, T2), E>` | Return on first `Err`, wait for all to complete
//! | `future::select` | `Result<T, E>` | Return on first value //! | [`Future::race`] | `Result<T, E>` | Return on first value
//! | `future::try_select` | `Result<T, E>` | Return on first `Ok`, reject on last Err //! | [`Future::try_race`] | `Result<T, E>` | Return on first `Ok`, reject on last Err
//!
//! [`Future::join`]: trait.Future.html#method.join
//! [`Future::try_join`]: trait.Future.html#method.try_join
//! [`Future::race`]: trait.Future.html#method.race
//! [`Future::try_race`]: trait.Future.html#method.try_race
#[doc(inline)] cfg_alloc! {
pub use async_macros::{join, try_join}; pub use future::Future;
pub(crate) mod future;
}
pub use future::Future; cfg_std! {
pub use pending::pending; pub use pending::pending;
pub use poll_fn::poll_fn; pub use poll_fn::poll_fn;
pub use ready::ready; pub use ready::ready;
pub use timeout::{timeout, TimeoutError};
pub(crate) mod future; mod pending;
mod pending; mod poll_fn;
mod poll_fn; mod ready;
mod ready; }
#[cfg(any(feature = "unstable", feature = "default"))]
pub use timeout::{timeout, TimeoutError};
#[cfg(any(feature = "unstable", feature = "default"))]
mod timeout; mod timeout;
cfg_unstable! { cfg_unstable! {
#[doc(inline)]
pub use async_macros::{select, try_select};
pub use into_future::IntoFuture; pub use into_future::IntoFuture;
pub(crate) use maybe_done::MaybeDone;
mod into_future; mod into_future;
mod maybe_done;
} }

@ -1,7 +1,7 @@
use std::future::Future;
use std::marker::PhantomData; use std::marker::PhantomData;
use std::pin::Pin; use std::pin::Pin;
use crate::future::Future;
use crate::task::{Context, Poll}; use crate::task::{Context, Poll};
/// Never resolves to a value. /// Never resolves to a value.

@ -1,6 +1,6 @@
use std::pin::Pin; use std::pin::Pin;
use std::future::Future;
use crate::future::Future;
use crate::task::{Context, Poll}; use crate::task::{Context, Poll};
/// Creates a new future wrapping around a function returning [`Poll`]. /// Creates a new future wrapping around a function returning [`Poll`].

@ -1,13 +1,13 @@
use std::error::Error; use std::error::Error;
use std::fmt; use std::fmt;
use std::future::Future;
use std::pin::Pin; use std::pin::Pin;
use std::time::Duration; use std::time::Duration;
use futures_timer::Delay;
use pin_project_lite::pin_project; use pin_project_lite::pin_project;
use crate::future::Future;
use crate::task::{Context, Poll}; use crate::task::{Context, Poll};
use crate::utils::{timer_after, Timer};
/// Awaits a future or times out after a duration of time. /// Awaits a future or times out after a duration of time.
/// ///
@ -33,20 +33,26 @@ pub async fn timeout<F, T>(dur: Duration, f: F) -> Result<T, TimeoutError>
where where
F: Future<Output = T>, F: Future<Output = T>,
{ {
let f = TimeoutFuture { TimeoutFuture::new(f, dur).await
future: f,
delay: Delay::new(dur),
};
f.await
} }
pin_project! { pin_project! {
/// A future that times out after a duration of time. /// A future that times out after a duration of time.
struct TimeoutFuture<F> { pub struct TimeoutFuture<F> {
#[pin] #[pin]
future: F, future: F,
#[pin] #[pin]
delay: Delay, delay: Timer,
}
}
impl<F> TimeoutFuture<F> {
#[allow(dead_code)]
pub(super) fn new(future: F, dur: Duration) -> TimeoutFuture<F> {
TimeoutFuture {
future,
delay: timer_after(dur),
}
} }
} }

@ -25,17 +25,19 @@ extension_trait! {
[`std::io::BufRead`]. [`std::io::BufRead`].
The [provided methods] do not really exist in the trait itself, but they become The [provided methods] do not really exist in the trait itself, but they become
available when the prelude is imported: available when [`BufReadExt`] from the [prelude] is imported:
``` ```
# #[allow(unused_imports)] # #[allow(unused_imports)]
use async_std::prelude::*; use async_std::io::prelude::*;
``` ```
[`std::io::BufRead`]: https://doc.rust-lang.org/std/io/trait.BufRead.html [`std::io::BufRead`]: https://doc.rust-lang.org/std/io/trait.BufRead.html
[`futures::io::AsyncBufRead`]: [`futures::io::AsyncBufRead`]:
https://docs.rs/futures-preview/0.3.0-alpha.17/futures/io/trait.AsyncBufRead.html https://docs.rs/futures/0.3/futures/io/trait.AsyncBufRead.html
[provided methods]: #provided-methods [provided methods]: #provided-methods
[`BufReadExt`]: ../io/prelude/trait.BufReadExt.html
[prelude]: ../prelude/index.html
"#] "#]
pub trait BufRead { pub trait BufRead {
#[doc = r#" #[doc = r#"
@ -62,6 +64,11 @@ extension_trait! {
fn consume(self: Pin<&mut Self>, amt: usize); fn consume(self: Pin<&mut Self>, amt: usize);
} }
#[doc = r#"
Extension methods for [`BufRead`].
[`BufRead`]: ../trait.BufRead.html
"#]
pub trait BufReadExt: futures_io::AsyncBufRead { pub trait BufReadExt: futures_io::AsyncBufRead {
#[doc = r#" #[doc = r#"
Reads all bytes into `buf` until the delimiter `byte` or EOF is reached. Reads all bytes into `buf` until the delimiter `byte` or EOF is reached.

@ -1,9 +1,9 @@
use std::mem; use std::mem;
use std::pin::Pin; use std::pin::Pin;
use std::str; use std::str;
use std::future::Future;
use super::read_until_internal; use super::read_until_internal;
use crate::future::Future;
use crate::io::{self, BufRead}; use crate::io::{self, BufRead};
use crate::task::{Context, Poll}; use crate::task::{Context, Poll};
@ -37,8 +37,12 @@ impl<T: BufRead + Unpin + ?Sized> Future for ReadLineFuture<'_, T> {
)) ))
})) }))
} else { } else {
debug_assert!(buf.is_empty()); #[allow(clippy::debug_assert_with_mut_call)]
debug_assert_eq!(*read, 0); {
debug_assert!(buf.is_empty());
debug_assert_eq!(*read, 0);
}
// Safety: `bytes` is a valid UTF-8 because `str::from_utf8` returned `Ok`. // Safety: `bytes` is a valid UTF-8 because `str::from_utf8` returned `Ok`.
mem::swap(unsafe { buf.as_mut_vec() }, bytes); mem::swap(unsafe { buf.as_mut_vec() }, bytes);
Poll::Ready(ret) Poll::Ready(ret)

@ -1,7 +1,7 @@
use std::pin::Pin; use std::pin::Pin;
use std::future::Future;
use super::read_until_internal; use super::read_until_internal;
use crate::future::Future;
use crate::io::{self, BufRead}; use crate::io::{self, BufRead};
use crate::task::{Context, Poll}; use crate::task::{Context, Poll};

@ -4,11 +4,9 @@ use std::{cmp, fmt};
use pin_project_lite::pin_project; use pin_project_lite::pin_project;
use crate::io::{self, BufRead, Read, Seek, SeekFrom}; use crate::io::{self, BufRead, Read, Seek, SeekFrom, DEFAULT_BUF_SIZE};
use crate::task::{Context, Poll}; use crate::task::{Context, Poll};
const DEFAULT_CAPACITY: usize = 8 * 1024;
pin_project! { pin_project! {
/// Adds buffering to any reader. /// Adds buffering to any reader.
/// ///
@ -72,7 +70,7 @@ impl<R: io::Read> BufReader<R> {
/// # Ok(()) }) } /// # Ok(()) }) }
/// ``` /// ```
pub fn new(inner: R) -> BufReader<R> { pub fn new(inner: R) -> BufReader<R> {
BufReader::with_capacity(DEFAULT_CAPACITY, inner) BufReader::with_capacity(DEFAULT_BUF_SIZE, inner)
} }
/// Creates a new buffered reader with the specified capacity. /// Creates a new buffered reader with the specified capacity.

@ -1,14 +1,11 @@
use std::fmt; use std::fmt;
use std::pin::Pin; use std::pin::Pin;
use futures_core::ready;
use pin_project_lite::pin_project; use pin_project_lite::pin_project;
use crate::io::write::WriteExt; use crate::io::write::WriteExt;
use crate::io::{self, Seek, SeekFrom, Write}; use crate::io::{self, Seek, SeekFrom, Write, DEFAULT_BUF_SIZE};
use crate::task::{Context, Poll}; use crate::task::{Context, Poll, ready};
const DEFAULT_CAPACITY: usize = 8 * 1024;
pin_project! { pin_project! {
/// Wraps a writer and buffers its output. /// Wraps a writer and buffers its output.
@ -25,14 +22,14 @@ pin_project! {
/// times. It also provides no advantage when writing to a destination that is /// times. It also provides no advantage when writing to a destination that is
/// in memory, like a `Vec<u8>`. /// in memory, like a `Vec<u8>`.
/// ///
/// When the `BufWriter` is dropped, the contents of its buffer will be written /// Unlike the `BufWriter` type in `std`, this type does not write out the
/// out. However, any errors that happen in the process of flushing the buffer /// contents of its buffer when it is dropped. Therefore, it is absolutely
/// when the writer is dropped will be ignored. Code that wishes to handle such /// critical that users explicitly flush the buffer before dropping a
/// errors must manually call [`flush`] before the writer is dropped. /// `BufWriter`.
/// ///
/// This type is an async version of [`std::io::BufReader`]. /// This type is an async version of [`std::io::BufWriter`].
/// ///
/// [`std::io::BufReader`]: https://doc.rust-lang.org/std/io/struct.BufReader.html /// [`std::io::BufWriter`]: https://doc.rust-lang.org/std/io/struct.BufWriter.html
/// ///
/// # Examples /// # Examples
/// ///
@ -64,10 +61,13 @@ pin_project! {
/// use async_std::prelude::*; /// use async_std::prelude::*;
/// ///
/// let mut stream = BufWriter::new(TcpStream::connect("127.0.0.1:34254").await?); /// let mut stream = BufWriter::new(TcpStream::connect("127.0.0.1:34254").await?);
///
/// for i in 0..10 { /// for i in 0..10 {
/// let arr = [i+1]; /// let arr = [i+1];
/// stream.write(&arr).await?; /// stream.write(&arr).await?;
/// }; /// };
///
/// stream.flush().await?;
/// # /// #
/// # Ok(()) }) } /// # Ok(()) }) }
/// ``` /// ```
@ -88,8 +88,32 @@ pin_project! {
} }
} }
/// An error returned by `into_inner` which combines an error that
/// happened while writing out the buffer, and the buffered writer object
/// which may be used to recover from the condition.
///
/// # Examples
///
/// ```no_run
/// # fn main() -> std::io::Result<()> { async_std::task::block_on(async {
/// use async_std::io::BufWriter;
/// use async_std::net::TcpStream;
///
/// let buf_writer = BufWriter::new(TcpStream::connect("127.0.0.1:34251").await?);
///
/// // unwrap the TcpStream and flush the buffer
/// let stream = match buf_writer.into_inner().await {
/// Ok(s) => s,
/// Err(e) => {
/// // Here, e is an IntoInnerError
/// panic!("An error occurred");
/// }
/// };
/// #
/// # Ok(()) }) }
///```
#[derive(Debug)] #[derive(Debug)]
pub struct IntoInnerError<W>(W, std::io::Error); pub struct IntoInnerError<W>(W, crate::io::Error);
impl<W: Write> BufWriter<W> { impl<W: Write> BufWriter<W> {
/// Creates a new `BufWriter` with a default buffer capacity. The default is currently 8 KB, /// Creates a new `BufWriter` with a default buffer capacity. The default is currently 8 KB,
@ -108,7 +132,7 @@ impl<W: Write> BufWriter<W> {
/// # Ok(()) }) } /// # Ok(()) }) }
/// ``` /// ```
pub fn new(inner: W) -> BufWriter<W> { pub fn new(inner: W) -> BufWriter<W> {
BufWriter::with_capacity(DEFAULT_CAPACITY, inner) BufWriter::with_capacity(DEFAULT_BUF_SIZE, inner)
} }
/// Creates a new `BufWriter` with the specified buffer capacity. /// Creates a new `BufWriter` with the specified buffer capacity.
@ -304,7 +328,7 @@ impl<W: Write> Write for BufWriter<W> {
impl<W: Write + fmt::Debug> fmt::Debug for BufWriter<W> { impl<W: Write + fmt::Debug> fmt::Debug for BufWriter<W> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("BufReader") f.debug_struct("BufWriter")
.field("writer", &self.inner) .field("writer", &self.inner)
.field("buf", &self.buf) .field("buf", &self.buf)
.finish() .finish()

@ -1,10 +1,11 @@
use std::future::Future;
use std::pin::Pin; use std::pin::Pin;
use pin_project_lite::pin_project; use pin_project_lite::pin_project;
use crate::future::Future;
use crate::io::{self, BufRead, BufReader, Read, Write}; use crate::io::{self, BufRead, BufReader, Read, Write};
use crate::task::{Context, Poll}; use crate::task::{Context, Poll};
use crate::utils::Context as _;
/// Copies the entire contents of a reader into a writer. /// Copies the entire contents of a reader into a writer.
/// ///
@ -43,6 +44,7 @@ use crate::task::{Context, Poll};
/// # /// #
/// # Ok(()) }) } /// # Ok(()) }) }
/// ``` /// ```
#[cfg(any(feature = "docs", not(feature = "unstable")))]
pub async fn copy<R, W>(reader: &mut R, writer: &mut W) -> io::Result<u64> pub async fn copy<R, W>(reader: &mut R, writer: &mut W) -> io::Result<u64>
where where
R: Read + Unpin + ?Sized, R: Read + Unpin + ?Sized,
@ -89,5 +91,92 @@ where
writer, writer,
amt: 0, amt: 0,
}; };
future.await future.await.context(|| String::from("io::copy failed"))
}
/// Copies the entire contents of a reader into a writer.
///
/// This function will continuously read data from `reader` and then
/// write it into `writer` in a streaming fashion until `reader`
/// returns EOF.
///
/// On success, the total number of bytes that were copied from
/// `reader` to `writer` is returned.
///
/// If youre wanting to copy the contents of one file to another and youre
/// working with filesystem paths, see the [`fs::copy`] function.
///
/// This function is an async version of [`std::io::copy`].
///
/// [`std::io::copy`]: https://doc.rust-lang.org/std/io/fn.copy.html
/// [`fs::copy`]: ../fs/fn.copy.html
///
/// # Errors
///
/// This function will return an error immediately if any call to `read` or
/// `write` returns an error. All instances of `ErrorKind::Interrupted` are
/// handled by this function and the underlying operation is retried.
///
/// # Examples
///
/// ```
/// # fn main() -> std::io::Result<()> { async_std::task::block_on(async {
/// #
/// use async_std::io;
///
/// let mut reader: &[u8] = b"hello";
/// let mut writer = io::stdout();
///
/// io::copy(&mut reader, &mut writer).await?;
/// #
/// # Ok(()) }) }
/// ```
#[cfg(all(feature = "unstable", not(feature = "docs")))]
pub async fn copy<R, W>(reader: R, writer: W) -> io::Result<u64>
where
R: Read + Unpin,
W: Write + Unpin,
{
pin_project! {
struct CopyFuture<R, W> {
#[pin]
reader: R,
#[pin]
writer: W,
amt: u64,
}
}
impl<R, W> Future for CopyFuture<R, W>
where
R: BufRead,
W: Write + Unpin,
{
type Output = io::Result<u64>;
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
let mut this = self.project();
loop {
let buffer = futures_core::ready!(this.reader.as_mut().poll_fill_buf(cx))?;
if buffer.is_empty() {
futures_core::ready!(this.writer.as_mut().poll_flush(cx))?;
return Poll::Ready(Ok(*this.amt));
}
let i = futures_core::ready!(this.writer.as_mut().poll_write(cx, buffer))?;
if i == 0 {
return Poll::Ready(Err(io::ErrorKind::WriteZero.into()));
}
*this.amt += i as u64;
this.reader.as_mut().consume(i);
}
}
}
let future = CopyFuture {
reader: BufReader::new(reader),
writer,
amt: 0,
};
future.await.context(|| String::from("io::copy failed"))
} }

@ -19,8 +19,8 @@
//! [`File`]s: //! [`File`]s:
//! //!
//! ```no_run //! ```no_run
//! use async_std::prelude::*;
//! use async_std::fs::File; //! use async_std::fs::File;
//! use async_std::prelude::*;
//! //!
//! # fn main() -> std::io::Result<()> { async_std::task::block_on(async { //! # fn main() -> std::io::Result<()> { async_std::task::block_on(async {
//! # //! #
@ -47,9 +47,9 @@
//! coming from: //! coming from:
//! //!
//! ```no_run //! ```no_run
//! use async_std::io::prelude::*;
//! use async_std::io::SeekFrom;
//! use async_std::fs::File; //! use async_std::fs::File;
//! use async_std::io::SeekFrom;
//! use async_std::prelude::*;
//! //!
//! # fn main() -> std::io::Result<()> { async_std::task::block_on(async { //! # fn main() -> std::io::Result<()> { async_std::task::block_on(async {
//! # //! #
@ -82,9 +82,9 @@
//! methods to any reader: //! methods to any reader:
//! //!
//! ```no_run //! ```no_run
//! use async_std::io::prelude::*;
//! use async_std::io::BufReader;
//! use async_std::fs::File; //! use async_std::fs::File;
//! use async_std::io::BufReader;
//! use async_std::prelude::*;
//! //!
//! # fn main() -> std::io::Result<()> { async_std::task::block_on(async { //! # fn main() -> std::io::Result<()> { async_std::task::block_on(async {
//! # //! #
@ -104,9 +104,9 @@
//! to [`write`][`Write::write`]: //! to [`write`][`Write::write`]:
//! //!
//! ```no_run //! ```no_run
//! use async_std::fs::File;
//! use async_std::io::prelude::*; //! use async_std::io::prelude::*;
//! use async_std::io::BufWriter; //! use async_std::io::BufWriter;
//! use async_std::fs::File;
//! //!
//! # fn main() -> std::io::Result<()> { async_std::task::block_on(async { //! # fn main() -> std::io::Result<()> { async_std::task::block_on(async {
//! # //! #
@ -116,8 +116,8 @@
//! //!
//! // write a byte to the buffer //! // write a byte to the buffer
//! writer.write(&[42]).await?; //! writer.write(&[42]).await?;
//!
//! } // the buffer is flushed once writer goes out of scope //! } // the buffer is flushed once writer goes out of scope
//! //
//! # //! #
//! # Ok(()) }) } //! # Ok(()) }) }
//! ``` //! ```
@ -179,9 +179,9 @@
//! lines: //! lines:
//! //!
//! ```no_run //! ```no_run
//! use async_std::prelude::*;
//! use async_std::io::BufReader;
//! use async_std::fs::File; //! use async_std::fs::File;
//! use async_std::io::BufReader;
//! use async_std::prelude::*;
//! //!
//! # fn main() -> std::io::Result<()> { async_std::task::block_on(async { //! # fn main() -> std::io::Result<()> { async_std::task::block_on(async {
//! # //! #
@ -269,45 +269,62 @@
//! [`Result`]: https://doc.rust-lang.org/std/result/enum.Result.html //! [`Result`]: https://doc.rust-lang.org/std/result/enum.Result.html
//! [`.unwrap()`]: https://doc.rust-lang.org/std/result/enum.Result.html#method.unwrap //! [`.unwrap()`]: https://doc.rust-lang.org/std/result/enum.Result.html#method.unwrap
#[doc(inline)] const DEFAULT_BUF_SIZE: usize = 8 * 1024;
pub use std::io::{Error, ErrorKind, IoSlice, IoSliceMut, Result, SeekFrom};
cfg_std! {
#[doc(inline)]
pub use std::io::{Error, ErrorKind, IoSlice, IoSliceMut, Result, SeekFrom};
pub use buf_read::{BufRead, Lines, Split};
pub use buf_reader::BufReader;
pub use buf_writer::{BufWriter, IntoInnerError};
pub use copy::copy;
pub use cursor::Cursor;
pub use empty::{empty, Empty};
pub use read::*;
pub use repeat::{repeat, Repeat};
pub use seek::Seek;
pub use sink::{sink, Sink};
pub use write::Write;
pub mod prelude;
pub use buf_read::{BufRead, Lines}; pub(crate) mod buf_read;
pub use buf_reader::BufReader; pub(crate) mod read;
pub use buf_writer::BufWriter; pub(crate) mod seek;
pub use copy::copy; pub(crate) mod write;
pub use cursor::Cursor; pub(crate) mod utils;
pub use empty::{empty, Empty};
pub use read::Read;
pub use repeat::{repeat, Repeat};
pub use seek::Seek;
pub use sink::{sink, Sink};
pub use stderr::{stderr, Stderr};
pub use stdin::{stdin, Stdin};
pub use stdout::{stdout, Stdout};
pub use timeout::timeout;
pub use write::Write;
// For use in the print macros. mod buf_reader;
#[doc(hidden)] mod buf_writer;
pub use stdio::{_eprint, _print}; mod copy;
mod cursor;
mod empty;
mod repeat;
mod sink;
}
pub mod prelude; cfg_default! {
// For use in the print macros.
#[doc(hidden)]
#[cfg(not(target_os = "unknown"))]
pub use stdio::{_eprint, _print};
pub(crate) mod buf_read; #[cfg(not(target_os = "unknown"))]
pub(crate) mod read; pub use stderr::{stderr, Stderr};
pub(crate) mod seek; #[cfg(not(target_os = "unknown"))]
pub(crate) mod write; pub use stdin::{stdin, Stdin};
#[cfg(not(target_os = "unknown"))]
pub use stdout::{stdout, Stdout};
pub use timeout::timeout;
mod buf_reader; mod timeout;
mod buf_writer; #[cfg(not(target_os = "unknown"))]
mod copy; mod stderr;
mod cursor; #[cfg(not(target_os = "unknown"))]
mod empty; mod stdin;
mod repeat; #[cfg(not(target_os = "unknown"))]
mod sink; mod stdio;
mod stderr; #[cfg(not(target_os = "unknown"))]
mod stdin; mod stdout;
mod stdio; }
mod stdout;
mod timeout;

@ -1,4 +1,4 @@
//! The async I/O Prelude //! The async I/O prelude.
//! //!
//! The purpose of this module is to alleviate imports of many common I/O traits //! The purpose of this module is to alleviate imports of many common I/O traits
//! by adding a glob import to the top of I/O heavy modules: //! by adding a glob import to the top of I/O heavy modules:
@ -17,11 +17,11 @@ pub use crate::io::Seek;
#[doc(no_inline)] #[doc(no_inline)]
pub use crate::io::Write; pub use crate::io::Write;
#[doc(hidden)] #[doc(inline)]
pub use crate::io::buf_read::BufReadExt as _; pub use crate::io::buf_read::BufReadExt;
#[doc(hidden)] #[doc(inline)]
pub use crate::io::read::ReadExt as _; pub use crate::io::read::ReadExt;
#[doc(hidden)] #[doc(inline)]
pub use crate::io::seek::SeekExt as _; pub use crate::io::seek::SeekExt;
#[doc(hidden)] #[doc(inline)]
pub use crate::io::write::WriteExt as _; pub use crate::io::write::WriteExt;

@ -32,7 +32,7 @@ impl<T: Read + Unpin> Stream for Bytes<T> {
} }
} }
#[cfg(test)] #[cfg(all(test, default))]
mod tests { mod tests {
use crate::io; use crate::io;
use crate::prelude::*; use crate::prelude::*;

@ -165,7 +165,7 @@ impl<T: BufRead, U: BufRead> BufRead for Chain<T, U> {
} }
} }
#[cfg(test)] #[cfg(all(test, default))]
mod tests { mod tests {
use crate::io; use crate::io;
use crate::prelude::*; use crate::prelude::*;

@ -17,6 +17,10 @@ use std::mem;
use crate::io::IoSliceMut; use crate::io::IoSliceMut;
pub use bytes::Bytes;
pub use chain::Chain;
pub use take::Take;
extension_trait! { extension_trait! {
use std::pin::Pin; use std::pin::Pin;
use std::ops::{Deref, DerefMut}; use std::ops::{Deref, DerefMut};
@ -31,7 +35,7 @@ extension_trait! {
[`std::io::Read`]. [`std::io::Read`].
Methods other than [`poll_read`] and [`poll_read_vectored`] do not really exist in the Methods other than [`poll_read`] and [`poll_read_vectored`] do not really exist in the
trait itself, but they become available when the prelude is imported: trait itself, but they become available when [`ReadExt`] from the [prelude] is imported:
``` ```
# #[allow(unused_imports)] # #[allow(unused_imports)]
@ -40,9 +44,11 @@ extension_trait! {
[`std::io::Read`]: https://doc.rust-lang.org/std/io/trait.Read.html [`std::io::Read`]: https://doc.rust-lang.org/std/io/trait.Read.html
[`futures::io::AsyncRead`]: [`futures::io::AsyncRead`]:
https://docs.rs/futures-preview/0.3.0-alpha.17/futures/io/trait.AsyncRead.html https://docs.rs/futures/0.3/futures/io/trait.AsyncRead.html
[`poll_read`]: #tymethod.poll_read [`poll_read`]: #tymethod.poll_read
[`poll_read_vectored`]: #method.poll_read_vectored [`poll_read_vectored`]: #method.poll_read_vectored
[`ReadExt`]: ../io/prelude/trait.ReadExt.html
[prelude]: ../prelude/index.html
"#] "#]
pub trait Read { pub trait Read {
#[doc = r#" #[doc = r#"
@ -66,6 +72,11 @@ extension_trait! {
} }
} }
#[doc = r#"
Extension methods for [`Read`].
[`Read`]: ../trait.Read.html
"#]
pub trait ReadExt: futures_io::AsyncRead { pub trait ReadExt: futures_io::AsyncRead {
#[doc = r#" #[doc = r#"
Reads some bytes from the byte stream. Reads some bytes from the byte stream.
@ -267,7 +278,7 @@ extension_trait! {
This function returns a new instance of `Read` which will read at most This function returns a new instance of `Read` which will read at most
`limit` bytes, after which it will always return EOF ([`Ok(0)`]). Any `limit` bytes, after which it will always return EOF ([`Ok(0)`]). Any
read errors will not count towards the number of bytes read and future read errors will not count towards the number of bytes read and future
calls to [`read()`] may succeed. calls to [`read`] may succeed.
# Examples # Examples
@ -275,7 +286,7 @@ extension_trait! {
[`File`]: ../fs/struct.File.html [`File`]: ../fs/struct.File.html
[`Ok(0)`]: ../../std/result/enum.Result.html#variant.Ok [`Ok(0)`]: ../../std/result/enum.Result.html#variant.Ok
[`read()`]: tymethod.read [`read`]: tymethod.read
```no_run ```no_run
# fn main() -> std::io::Result<()> { async_std::task::block_on(async { # fn main() -> std::io::Result<()> { async_std::task::block_on(async {
@ -294,11 +305,11 @@ extension_trait! {
# Ok(()) }) } # Ok(()) }) }
``` ```
"#] "#]
fn take(self, limit: u64) -> take::Take<Self> fn take(self, limit: u64) -> Take<Self>
where where
Self: Sized, Self: Sized,
{ {
take::Take { inner: self, limit } Take { inner: self, limit }
} }
#[doc = r#" #[doc = r#"
@ -370,8 +381,8 @@ extension_trait! {
# Ok(()) }) } # Ok(()) }) }
``` ```
"#] "#]
fn bytes(self) -> bytes::Bytes<Self> where Self: Sized { fn bytes(self) -> Bytes<Self> where Self: Sized {
bytes::Bytes { inner: self } Bytes { inner: self }
} }
#[doc = r#" #[doc = r#"
@ -406,8 +417,8 @@ extension_trait! {
# Ok(()) }) } # Ok(()) }) }
``` ```
"#] "#]
fn chain<R: Read>(self, next: R) -> chain::Chain<Self, R> where Self: Sized { fn chain<R: Read>(self, next: R) -> Chain<Self, R> where Self: Sized {
chain::Chain { first: self, second: next, done_first: false } Chain { first: self, second: next, done_first: false }
} }
} }
@ -466,13 +477,13 @@ unsafe fn initialize<R: futures_io::AsyncRead>(_reader: &R, buf: &mut [u8]) {
std::ptr::write_bytes(buf.as_mut_ptr(), 0, buf.len()) std::ptr::write_bytes(buf.as_mut_ptr(), 0, buf.len())
} }
#[cfg(test)] #[cfg(all(test, not(target_os = "unknown")))]
mod tests { mod tests {
use crate::io; use crate::io;
use crate::prelude::*; use crate::prelude::*;
#[test] #[test]
fn test_read_by_ref() -> io::Result<()> { fn test_read_by_ref() {
crate::task::block_on(async { crate::task::block_on(async {
let mut f = io::Cursor::new(vec![0u8, 1, 2, 3, 4, 5, 6, 7, 8]); let mut f = io::Cursor::new(vec![0u8, 1, 2, 3, 4, 5, 6, 7, 8]);
let mut buffer = Vec::new(); let mut buffer = Vec::new();
@ -482,14 +493,13 @@ mod tests {
let reference = f.by_ref(); let reference = f.by_ref();
// read at most 5 bytes // read at most 5 bytes
assert_eq!(reference.take(5).read_to_end(&mut buffer).await?, 5); assert_eq!(reference.take(5).read_to_end(&mut buffer).await.unwrap(), 5);
assert_eq!(&buffer, &[0, 1, 2, 3, 4]) assert_eq!(&buffer, &[0, 1, 2, 3, 4])
} // drop our &mut reference so we can use f again } // drop our &mut reference so we can use f again
// original file still usable, read the rest // original file still usable, read the rest
assert_eq!(f.read_to_end(&mut other_buffer).await?, 4); assert_eq!(f.read_to_end(&mut other_buffer).await.unwrap(), 4);
assert_eq!(&other_buffer, &[5, 6, 7, 8]); assert_eq!(&other_buffer, &[5, 6, 7, 8]);
Ok(()) });
})
} }
} }

@ -1,6 +1,6 @@
use std::pin::Pin; use std::pin::Pin;
use std::future::Future;
use crate::future::Future;
use crate::io::{self, Read}; use crate::io::{self, Read};
use crate::task::{Context, Poll}; use crate::task::{Context, Poll};

@ -1,7 +1,7 @@
use std::mem; use std::mem;
use std::pin::Pin; use std::pin::Pin;
use std::future::Future;
use crate::future::Future;
use crate::io::{self, Read}; use crate::io::{self, Read};
use crate::task::{Context, Poll}; use crate::task::{Context, Poll};

@ -1,6 +1,6 @@
use std::pin::Pin; use std::pin::Pin;
use std::future::Future;
use crate::future::Future;
use crate::io::{self, Read}; use crate::io::{self, Read};
use crate::task::{Context, Poll}; use crate::task::{Context, Poll};

@ -1,9 +1,9 @@
use std::mem; use std::mem;
use std::pin::Pin; use std::pin::Pin;
use std::str; use std::str;
use std::future::Future;
use super::read_to_end_internal; use super::read_to_end_internal;
use crate::future::Future;
use crate::io::{self, Read}; use crate::io::{self, Read};
use crate::task::{Context, Poll}; use crate::task::{Context, Poll};
@ -37,7 +37,11 @@ impl<T: Read + Unpin + ?Sized> Future for ReadToStringFuture<'_, T> {
)) ))
})) }))
} else { } else {
debug_assert!(buf.is_empty()); #[allow(clippy::debug_assert_with_mut_call)]
{
debug_assert!(buf.is_empty());
}
// Safety: `bytes` is a valid UTF-8 because `str::from_utf8` returned `Ok`. // Safety: `bytes` is a valid UTF-8 because `str::from_utf8` returned `Ok`.
mem::swap(unsafe { buf.as_mut_vec() }, bytes); mem::swap(unsafe { buf.as_mut_vec() }, bytes);
Poll::Ready(ret) Poll::Ready(ret)

@ -1,6 +1,6 @@
use std::pin::Pin; use std::pin::Pin;
use std::future::Future;
use crate::future::Future;
use crate::io::{self, IoSliceMut, Read}; use crate::io::{self, IoSliceMut, Read};
use crate::task::{Context, Poll}; use crate::task::{Context, Poll};

@ -218,7 +218,7 @@ impl<T: BufRead> BufRead for Take<T> {
} }
} }
#[cfg(test)] #[cfg(all(test, not(target_os = "unknown")))]
mod tests { mod tests {
use crate::io; use crate::io;
use crate::prelude::*; use crate::prelude::*;

@ -18,7 +18,7 @@ extension_trait! {
[`std::io::Seek`]. [`std::io::Seek`].
The [provided methods] do not really exist in the trait itself, but they become The [provided methods] do not really exist in the trait itself, but they become
available when the prelude is imported: available when [`SeekExt`] the [prelude] is imported:
``` ```
# #[allow(unused_imports)] # #[allow(unused_imports)]
@ -27,8 +27,10 @@ extension_trait! {
[`std::io::Seek`]: https://doc.rust-lang.org/std/io/trait.Seek.html [`std::io::Seek`]: https://doc.rust-lang.org/std/io/trait.Seek.html
[`futures::io::AsyncSeek`]: [`futures::io::AsyncSeek`]:
https://docs.rs/futures-preview/0.3.0-alpha.17/futures/io/trait.AsyncSeek.html https://docs.rs/futures/0.3/futures/io/trait.AsyncSeek.html
[provided methods]: #provided-methods [provided methods]: #provided-methods
[`SeekExt`]: ../io/prelude/trait.SeekExt.html
[prelude]: ../prelude/index.html
"#] "#]
pub trait Seek { pub trait Seek {
#[doc = r#" #[doc = r#"
@ -41,6 +43,11 @@ extension_trait! {
) -> Poll<io::Result<u64>>; ) -> Poll<io::Result<u64>>;
} }
#[doc = r#"
Extension methods for [`Seek`].
[`Seek`]: ../trait.Seek.html
"#]
pub trait SeekExt: futures_io::AsyncSeek { pub trait SeekExt: futures_io::AsyncSeek {
#[doc = r#" #[doc = r#"
Seeks to a new position in a byte stream. Seeks to a new position in a byte stream.

@ -1,6 +1,6 @@
use std::pin::Pin; use std::pin::Pin;
use std::future::Future;
use crate::future::Future;
use crate::io::{self, Seek, SeekFrom}; use crate::io::{self, Seek, SeekFrom};
use crate::task::{Context, Poll}; use crate::task::{Context, Poll};

@ -1,9 +1,9 @@
use std::pin::Pin; use std::pin::Pin;
use std::sync::Mutex; use std::sync::Mutex;
use std::future::Future;
use crate::future::Future;
use crate::io::{self, Write}; use crate::io::{self, Write};
use crate::task::{blocking, Context, JoinHandle, Poll}; use crate::task::{spawn_blocking, Context, JoinHandle, Poll};
/// Constructs a new handle to the standard error of the current process. /// Constructs a new handle to the standard error of the current process.
/// ///
@ -89,11 +89,12 @@ enum Operation {
impl Write for Stderr { impl Write for Stderr {
fn poll_write( fn poll_write(
mut self: Pin<&mut Self>, self: Pin<&mut Self>,
cx: &mut Context<'_>, cx: &mut Context<'_>,
buf: &[u8], buf: &[u8],
) -> Poll<io::Result<usize>> { ) -> Poll<io::Result<usize>> {
let state = &mut *self.0.lock().unwrap(); let mut state_guard = self.0.lock().unwrap();
let state = &mut *state_guard;
loop { loop {
match state { match state {
@ -124,7 +125,7 @@ impl Write for Stderr {
inner.buf[..buf.len()].copy_from_slice(buf); inner.buf[..buf.len()].copy_from_slice(buf);
// Start the operation asynchronously. // Start the operation asynchronously.
*state = State::Busy(blocking::spawn(move || { *state = State::Busy(spawn_blocking(move || {
let res = std::io::Write::write(&mut inner.stderr, &inner.buf); let res = std::io::Write::write(&mut inner.stderr, &inner.buf);
inner.last_op = Some(Operation::Write(res)); inner.last_op = Some(Operation::Write(res));
State::Idle(Some(inner)) State::Idle(Some(inner))
@ -137,8 +138,9 @@ impl Write for Stderr {
} }
} }
fn poll_flush(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<io::Result<()>> { fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<io::Result<()>> {
let state = &mut *self.0.lock().unwrap(); let mut state_guard = self.0.lock().unwrap();
let state = &mut *state_guard;
loop { loop {
match state { match state {
@ -152,7 +154,7 @@ impl Write for Stderr {
let mut inner = opt.take().unwrap(); let mut inner = opt.take().unwrap();
// Start the operation asynchronously. // Start the operation asynchronously.
*state = State::Busy(blocking::spawn(move || { *state = State::Busy(spawn_blocking(move || {
let res = std::io::Write::flush(&mut inner.stderr); let res = std::io::Write::flush(&mut inner.stderr);
inner.last_op = Some(Operation::Flush(res)); inner.last_op = Some(Operation::Flush(res));
State::Idle(Some(inner)) State::Idle(Some(inner))

@ -1,9 +1,11 @@
use std::future::Future;
use std::pin::Pin; use std::pin::Pin;
use std::sync::Mutex; use std::sync::Mutex;
use crate::future::{self, Future}; use crate::future;
use crate::io::{self, Read}; use crate::io::{self, Read};
use crate::task::{blocking, Context, JoinHandle, Poll}; use crate::task::{spawn_blocking, Context, JoinHandle, Poll};
use crate::utils::Context as _;
/// Constructs a new handle to the standard input of the current process. /// Constructs a new handle to the standard input of the current process.
/// ///
@ -127,7 +129,7 @@ impl Stdin {
let mut inner = opt.take().unwrap(); let mut inner = opt.take().unwrap();
// Start the operation asynchronously. // Start the operation asynchronously.
*state = State::Busy(blocking::spawn(move || { *state = State::Busy(spawn_blocking(move || {
inner.line.clear(); inner.line.clear();
let res = inner.stdin.read_line(&mut inner.line); let res = inner.stdin.read_line(&mut inner.line);
inner.last_op = Some(Operation::ReadLine(res)); inner.last_op = Some(Operation::ReadLine(res));
@ -141,16 +143,18 @@ impl Stdin {
} }
}) })
.await .await
.context(|| String::from("could not read line on stdin"))
} }
} }
impl Read for Stdin { impl Read for Stdin {
fn poll_read( fn poll_read(
mut self: Pin<&mut Self>, self: Pin<&mut Self>,
cx: &mut Context<'_>, cx: &mut Context<'_>,
buf: &mut [u8], buf: &mut [u8],
) -> Poll<io::Result<usize>> { ) -> Poll<io::Result<usize>> {
let state = &mut *self.0.lock().unwrap(); let mut state_guard = self.0.lock().unwrap();
let state = &mut *state_guard;
loop { loop {
match state { match state {
@ -180,7 +184,7 @@ impl Read for Stdin {
} }
// Start the operation asynchronously. // Start the operation asynchronously.
*state = State::Busy(blocking::spawn(move || { *state = State::Busy(spawn_blocking(move || {
let res = std::io::Read::read(&mut inner.stdin, &mut inner.buf); let res = std::io::Read::read(&mut inner.stdin, &mut inner.buf);
inner.last_op = Some(Operation::Read(res)); inner.last_op = Some(Operation::Read(res));
State::Idle(Some(inner)) State::Idle(Some(inner))

@ -1,9 +1,9 @@
use std::pin::Pin; use std::pin::Pin;
use std::sync::Mutex; use std::sync::Mutex;
use std::future::Future;
use crate::future::Future;
use crate::io::{self, Write}; use crate::io::{self, Write};
use crate::task::{blocking, Context, JoinHandle, Poll}; use crate::task::{spawn_blocking, Context, JoinHandle, Poll};
/// Constructs a new handle to the standard output of the current process. /// Constructs a new handle to the standard output of the current process.
/// ///
@ -89,11 +89,12 @@ enum Operation {
impl Write for Stdout { impl Write for Stdout {
fn poll_write( fn poll_write(
mut self: Pin<&mut Self>, self: Pin<&mut Self>,
cx: &mut Context<'_>, cx: &mut Context<'_>,
buf: &[u8], buf: &[u8],
) -> Poll<io::Result<usize>> { ) -> Poll<io::Result<usize>> {
let state = &mut *self.0.lock().unwrap(); let mut state_guard = self.0.lock().unwrap();
let state = &mut *state_guard;
loop { loop {
match state { match state {
@ -124,7 +125,7 @@ impl Write for Stdout {
inner.buf[..buf.len()].copy_from_slice(buf); inner.buf[..buf.len()].copy_from_slice(buf);
// Start the operation asynchronously. // Start the operation asynchronously.
*state = State::Busy(blocking::spawn(move || { *state = State::Busy(spawn_blocking(move || {
let res = std::io::Write::write(&mut inner.stdout, &inner.buf); let res = std::io::Write::write(&mut inner.stdout, &inner.buf);
inner.last_op = Some(Operation::Write(res)); inner.last_op = Some(Operation::Write(res));
State::Idle(Some(inner)) State::Idle(Some(inner))
@ -137,8 +138,9 @@ impl Write for Stdout {
} }
} }
fn poll_flush(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<io::Result<()>> { fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<io::Result<()>> {
let state = &mut *self.0.lock().unwrap(); let mut state_guard = self.0.lock().unwrap();
let state = &mut *state_guard;
loop { loop {
match state { match state {
@ -152,7 +154,7 @@ impl Write for Stdout {
let mut inner = opt.take().unwrap(); let mut inner = opt.take().unwrap();
// Start the operation asynchronously. // Start the operation asynchronously.
*state = State::Busy(blocking::spawn(move || { *state = State::Busy(spawn_blocking(move || {
let res = std::io::Write::flush(&mut inner.stdout); let res = std::io::Write::flush(&mut inner.stdout);
inner.last_op = Some(Operation::Flush(res)); inner.last_op = Some(Operation::Flush(res));
State::Idle(Some(inner)) State::Idle(Some(inner))

@ -1,12 +1,12 @@
use std::future::Future;
use std::pin::Pin; use std::pin::Pin;
use std::task::{Context, Poll}; use std::task::{Context, Poll};
use std::time::Duration; use std::time::Duration;
use futures_timer::Delay;
use pin_project_lite::pin_project; use pin_project_lite::pin_project;
use crate::future::Future;
use crate::io; use crate::io;
use crate::utils::{timer_after, Timer};
/// Awaits an I/O future or times out after a duration of time. /// Awaits an I/O future or times out after a duration of time.
/// ///
@ -37,7 +37,7 @@ where
F: Future<Output = io::Result<T>>, F: Future<Output = io::Result<T>>,
{ {
Timeout { Timeout {
timeout: Delay::new(dur), timeout: timer_after(dur),
future: f, future: f,
} }
.await .await
@ -53,7 +53,7 @@ pin_project! {
#[pin] #[pin]
future: F, future: F,
#[pin] #[pin]
timeout: Delay, timeout: Timer,
} }
} }

@ -0,0 +1,42 @@
use crate::utils::Context;
use std::{error::Error as StdError, fmt, io};
/// Wrap `std::io::Error` with additional message
///
/// Keeps the original error kind and stores the original I/O error as `source`.
impl<T> Context for Result<T, std::io::Error> {
fn context(self, message: impl Fn() -> String) -> Self {
self.map_err(|e| VerboseError::wrap(e, message()))
}
}
#[derive(Debug)]
pub(crate) struct VerboseError {
source: io::Error,
message: String,
}
impl VerboseError {
pub(crate) fn wrap(source: io::Error, message: impl Into<String>) -> io::Error {
io::Error::new(
source.kind(),
VerboseError {
source,
message: message.into(),
},
)
}
}
impl fmt::Display for VerboseError {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "{}", self.message)
}
}
impl StdError for VerboseError {
fn source(&self) -> Option<&(dyn StdError + 'static)> {
Some(&self.source)
}
}

@ -1,6 +1,6 @@
use std::pin::Pin; use std::pin::Pin;
use std::future::Future;
use crate::future::Future;
use crate::io::{self, Write}; use crate::io::{self, Write};
use crate::task::{Context, Poll}; use crate::task::{Context, Poll};

@ -26,7 +26,7 @@ extension_trait! {
Methods other than [`poll_write`], [`poll_write_vectored`], [`poll_flush`], and Methods other than [`poll_write`], [`poll_write_vectored`], [`poll_flush`], and
[`poll_close`] do not really exist in the trait itself, but they become available when [`poll_close`] do not really exist in the trait itself, but they become available when
the prelude is imported: [`WriteExt`] from the [prelude] is imported:
``` ```
# #[allow(unused_imports)] # #[allow(unused_imports)]
@ -35,11 +35,13 @@ extension_trait! {
[`std::io::Write`]: https://doc.rust-lang.org/std/io/trait.Write.html [`std::io::Write`]: https://doc.rust-lang.org/std/io/trait.Write.html
[`futures::io::AsyncWrite`]: [`futures::io::AsyncWrite`]:
https://docs.rs/futures-preview/0.3.0-alpha.17/futures/io/trait.AsyncWrite.html https://docs.rs/futures/0.3/futures/io/trait.AsyncWrite.html
[`poll_write`]: #tymethod.poll_write [`poll_write`]: #tymethod.poll_write
[`poll_write_vectored`]: #method.poll_write_vectored [`poll_write_vectored`]: #method.poll_write_vectored
[`poll_flush`]: #tymethod.poll_flush [`poll_flush`]: #tymethod.poll_flush
[`poll_close`]: #tymethod.poll_close [`poll_close`]: #tymethod.poll_close
[`WriteExt`]: ../io/prelude/trait.WriteExt.html
[prelude]: ../prelude/index.html
"#] "#]
pub trait Write { pub trait Write {
#[doc = r#" #[doc = r#"
@ -74,6 +76,11 @@ extension_trait! {
fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<io::Result<()>>; fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<io::Result<()>>;
} }
#[doc = r#"
Extension methods for [`Write`].
[`Write`]: ../trait.Write.html
"#]
pub trait WriteExt: futures_io::AsyncWrite { pub trait WriteExt: futures_io::AsyncWrite {
#[doc = r#" #[doc = r#"
Writes some bytes into the byte stream. Writes some bytes into the byte stream.

Some files were not shown because too many files have changed in this diff Show More

Loading…
Cancel
Save