• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Changelog
2All notable changes to this project will be documented in this file.
3
4The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
5and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
6
7### Categories each change fall into
8
9* **Added**: for new features.
10* **Changed**: for changes in existing functionality.
11* **Deprecated**: for soon-to-be removed features.
12* **Removed**: for now removed features.
13* **Fixed**: for any bug fixes.
14* **Security**: in case of vulnerabilities.
15
16
17## [Unreleased]
18
19
20## [0.1.6] - 2023-09-14
21### Added
22* Add `into_raw` and `from_raw` methods on both `Sender` and `Receiver`. Allows passing `oneshot`
23  channels over FFI without an extra layer of heap allocation.
24
25
26## [0.1.5] - 2022-09-01
27### Fixed
28- Handle the UNPARKING state correctly in all recv methods. `try_recv` will now not panic
29  if used on a `Receiver` that is being unparked from an async wait. The other `recv` methods
30  will still panic (as they should), but with a better error message.
31
32
33## [0.1.4] - 2022-08-30
34### Changed
35- Upgrade to Rust edition 2021. Also increases the MSRV to Rust 1.60.
36- Add null-pointer optimization to `Sender`, `Receiver` and `SendError`.
37  This reduces the call stack size of Sender::send and it makes
38  `Option<Sender>` and `Option<Receiver>` pointer sized (#18).
39- Relax the memory ordering of all atomic operations from `SeqCst` to the most appropriate
40  lower ordering (#17 + #20).
41
42### Fixed
43- Fix undefined behavior due to multiple mutable references to the same channel instance (#18).
44- Fix race condition that could happen during unparking of a receiving `Receiver` (#17 + #20).
45
46
47## [0.1.3] - 2021-11-23
48### Fixed
49- Keep the *last* `Waker` in `Future::poll`, not the *first* one. Stops breaking the contract
50  on how futures should work.
51
52
53## [0.1.2] - 2020-08-11
54### Fixed
55- Fix unreachable code panic that happened if the `Receiver` of an empty but open channel was
56  polled and then dropped.
57
58
59## [0.1.1] - 2020-05-10
60Initial implementation. Supports basically all the (for now) intended functionality.
61Sender is as lock-free as I think it can get and the receiver can both do thread blocking
62and be awaited asynchronously. The receiver also has a wait-free `try_recv` method.
63
64The crate has two features. They are activated by default, but the user can opt out of async
65support as well as usage of libstd (making the crate `no_std` but still requiring liballoc)
66
67
68## [0.1.0] - 2019-05-30
69Name reserved on crate.io by someone other than the author of this crate.
70