sluice

Changed

• Replace futures-channel with async-channel for the underlying channel implementation for pipes. This delivers slightly better performance and compile times. (#18, #19)

Fixed

• Fix panic caused by race condition when writing while dropping reader. (#16)

Changed

• Remove the futures-util dependency, which is a bit heavier than desired, and we didn't really need it anyway.

Added

• PipeReader now also implements AsyncBufRead.(#8)

Fixed

• Fix io feature of futures-util missing from dependencies, causing a compile error if the feature was not being implicitly enabled by some other dependency (like dev dependencies). (#10, #11) @ignatenkobrain

Changed

• Do not require default features for futures-util since we do not use them. (#7) @jakobhellermann

Changed

• Upgraded from futures-preview to futures 0.3. This is a breaking change.

Fixed

• Fix a bug where reading from a pipe after already returning EOF would cause a panic. This was caused by Stream::poll_next used internally in the chunked implementation panicking after returning the final stream item, which it is allowed to do according to the current documentation. (#6)

Improvements

• Sluice now only depends on the futures sub-crates that it actually uses.
• Add a slight optimization to the chunked pipe writer that checks if the pipe is closed first before writing. Before the optimization, we were first copying the entire write buffer to the pipe, and then discovering that the pipe is closed and returning an error.

Added

• Added Debug implementations for PipeReader and PipeWriter.

Fixed

• Fix an issue where dropping the writer while some data still remained in the pipe caused the reader to return a BrokenPipe error instead of allowing you to drain the bytes in the pipe until empty.

• Added a new io module featuring in-memory pipes. These pipes work similar to I/O streams but are based on an atomic ring buffer internally.

• Fixed an issue when resizing an unbounded buffer that is empty that resulted in the buffer length being reported incorrectly.

• Fixed a logical error where pushing small amounts of data repeatedly into the buffer would overwrite existing data.

0.2 is here! This release is a breaking change with API refactorings and improvements.

• Refactored module hierarchy to make more sense and to leave room for more data structures in the future.
• Add new traits for buffers that all buffer types can implement.
• Add new bounded atomic buffer implementation.

• Fixed a critical logic error causing items to not be removable when the buffer length reached exactly the current capacity of the buffer.

• Initial release.