CHANGELOG.md

Changelog

circular-buffer 1.0.0

New features

• When the buffer is full, push_front() and push_back() now return the replaced element (contributed by Zacchary Dempsey-Plante).

Other changes

• Increased the minimum supported rustc version to 1.82

circular-buffer 0.1.9

• This release does not introduce any new features or bug fixes. It only changes the dev-dependencies used by unit tests (contributed by Ben Beasley).

circular-buffer 0.1.8

New features

• Added optional support for embedded-io and embedded-io-async (contributed by DaneSlattery).

Other changes

• Renamed the use_std cargo feature to std (the old use_std is now an alias for std, so this is not a breaking change).

circular-buffer 0.1.7

New features

• Implemented the traits Index<usize> and IndexMut<usize> for CircularBuffer. Now elements of the buffer can be accessed and modified with indexing operations (buf[index]), like in the following example:

  use circular_buffer::CircularBuffer;
  let mut buf = CircularBuffer::<5, char>::from(['a', 'b', 'c']);
  assert_eq!(buf[0], 'a');
  buf[1] = 'd';
  assert_eq!(buf[1], 'd');

• Added new methods to fill the whole buffer, or the spare capacity of the buffer: fill(), fill_with(), fill_spare(), fill_spare_with().

• Added a new alloc feature that brings heap-allocation features to no_std environments through the alloc crate (contributed by Haoud).

• Implemented the BufRead trait for CircularBuffer (not available in no_std environments).

Bug fixes

• Fixed an out-of-bounds read in remove().

• Removed #[must_use] from drain(): it is perfectly acceptable to ignore the return value from this method.

Other changes

• Raised the minimum rustc version to 1.65

circular-buffer 0.1.6

• Fixed a bug in bug in bug in the PartialEq implementation that would lead to a panic in some circumstances.

circular-buffer 0.1.5

• Added try_push_back() and try_push_front() as non-overwriting alternatives to push_back() and push_front() (contributed by Rinat Shigapov in GH-5).

• Added drain() to remove ranges of elements.

• Added make_contiguous() to return a contiguous mutable slice of elements.

• Iter and IterMut now implement the Default trait.

circular-buffer 0.1.4

• Fixed a bug in range() and range_mut() that made them return more elements than requested in some circumstances.

circular-buffer 0.1.3

• Fixed range() and range_mut() when passing an empty range (contributed by Icxolu in GH-4).

circular-buffer 0.1.2

• Made extend_from_slice() safer by ensuring that all cloned elements get dropped in case a panic occurs.

• Optimized all PartialEq implementations.

• Fixed a strict-provenance error in swap() (contributed by René Kijewski in GH-2).

circular-buffer 0.1.1

• Made circular-buffer compatible with the stable version of rustc.

circular-buffer 0.1.0

• Initial release.