# Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.10.0] - 2022-10-06
### Changed
- make `smallvec::Drain` covariant over the generic type `T`
- make `arrayvec::Drain` covariant over the generic type `T`
- cleanup arraystring docs

### Fixed
- fix `clippy::explicit-auto-deref` warning detected by latest `beta` toolchain

### Added
- add `aformat!` macro to format a string on stack, returning `Result<ArrayString>`.

  The difference between `lformat!` and `aformat!` is the returned type. The former
  returns a plain `ArrayString`. However, as `ArrayString` is a fixed-capacity data structure,
  the format is lossy. In other words, the result may be a truncated string.
  `aformat!` on the contrary checks that formatting completed successfully, and `ArrayString`
  had enough space to hold the whole formatted string. In case when `ArrayString`'s capacity is
  not enough to hold a fully formatted string, `aformat!` returns an `Err`.

## [0.9.0] - 2022-09-09
### Changed
- enable all optional crate features by default.

  From now on all public types are enabled by default, and `cds` links with the standard
  library `std`. To build in `no_std` environment, use `default-features = false`
  and choose the required features explicitly.

- make `SmallVec` covariant over the generic type `T`.

  This means, for example, that `SmallVec<&'static str, 8>` can be used where
  `SmallVec<&'a str, 8>` is expected.
  More information can be found [here](https://doc.rust-lang.org/nomicon/vec/vec-layout.html#layout).

- make `SmallVec` implement `Send` and `Sync` when `T` is `Send` or `Sync` respectively

## [0.8.1] - 2022-07-22
### Fixed
- fix new `miri` errors,
  following [latest developments](https://www.ralfj.de/blog/2022/07/02/miri.html) in this tool

### Changed
- cleanup documentation

## [0.8.0] - 2022-06-17
### Added
- add `SmallVec` implementation

## [0.7.0] - 2022-06-05
### Changed
- implement `Debug` on length types
- implement `Debug` on spare memory policy types

### Fixed
- fix `ArrayVec::drain` of ZST types. Previously more than required elements were dropped.

## [0.6.0] - 2022-03-25
This release changes the error types to belong to the modules they are used in
instead of "trying" to be generic.

### Changed
- rename `CapacityError` to `InsufficientCapacityError`
- move the error types from the common module `cds::errors` into per-collection modules
  `cds::arrayvec::errors` and `cds::arraystring::errors`. Every collection module
  has its own error types now, even if part of the types are very similar.
- update the `Display` implementation of the error types to reflect the collection
  module they belong to

### Removed
- remove the top-level `cds::errors` module as all of its contents were moved out

## [0.5.0] - 2022-03-18
### Added
- add `core::fmt::Write` implementation for `ArrayString`

### Changed
- rename `cds::arraystring::format` to `cds::arraystring::format_lossy`
- rename `cds::format!` to `cds::lformat!` to stress the lossiness of the operation
- add default values for optional generic parameters and place the mandatory parameters first:
  - `ArrayVec<T, L, SM, C>` is now `ArrayVec<T, C, L = Usize, SM = Uninitialized>`
  - `ArrayString<L, SM, C>` is now `ArrayString<C, L = Usize, SM = Uninitialized>`
- the `MSRV` is now `v1.59.0`, which is the first version that supports
  [interleaved const generics]

[interleaved const generics]: https://blog.rust-lang.org/2022/02/24/Rust-1.59.0.html#const-generics-defaults-and-interleaving

## [0.4.0] - 2022-03-12
### Added
- add `ArrayString::add_str`. The method copies characters from a string slice,
  as much as the spare capacity allows, and returns the number of bytes copied.
- add `arraystring::format` function that formats and returns an `ArrayString`
- add `cds::format!` macro for convenient `ArrayString` formatting

## [0.3.0] - 2022-03-06
This release is dedicated to `ArrayString`.

### Added
- add crate feature `alloc` which enables linkage with the standard [alloc] crate
  and usage of its types. `std` feature which enables the standard library implicitly
  enables `alloc`.
- add struct `IndexError` which denotes an out-of-bounds or misaligned index.
- add initial implementation of `ArrayString`
- add initial implementation of array-string fuzz test and benchmark

[alloc]: https://doc.rust-lang.org/alloc/

## [0.2.0] - 2022-03-03
This is a small refactoring-only release done in preparation for `ArrayString`.

### Added
- add new top-level module `cds::mem` for code that deals with memory
- add new top-level module `cds::len` for length types

### Changed
- rename enum `InsertError` and `InsertErrorVal` variants:
  - `IndexOutOfBounds` to `InvalidIndex`
  - `CapacityError` to `InsufficientCapacity`
- move trait `SpareMemoryPolicy` and its implementors from `cds::defs` to `cds::mem`
- move trait `LengthType` and its implementors from `cds::defs` to `cds::len`

### Removed
- remove the top-level module `cds::defs` as its contents were moved out to other modules

## [0.1.0] - 2022-02-18
### Added
- add performance tests for `ArrayVec`

## [0.0.6] - 2022-02-05
### Added
- add `ArrayVec::copy_from_slice`
- add `ArrayVec::copy_from_slice_unchecked`
- add `ArrayVec::try_copy_from_slice`
- implement `std::io::Write` on `ArrayVec`

## [0.0.5] - 2022-02-04
### Added
- add `ArrayVec::resize` implementation
- add `ArrayVec::resize_mut` implementation

## [0.0.4] - 2022-01-28
### Added
- add `ArrayVec::drain` implementation
- add `ArrayVec::retain` implementation
- add `ArrayVec::retain_mut` implementation
- implement the `Extend` trait on `ArrayVec`
- add a fuzz test

## [0.0.3] - 2021-12-18
### Added
- add `ArrayVec::try_push_val` and `ArrayVec::try_insert_val` methods, to return an element to the caller
  in case of an error.
- add `InsertErrorVal` and `CapacityErrorVal` types to be used in `try_insert_val` and `try_push_val` respectively.
- add full test coverage for existing methods.

## [0.0.2] - 2021-12-10
### Added
- `LengthType` - allows customization of the type used to track a fixed-capacity collection's
  length.
- `SpareMemoryPolicy` - allows custom behavior with spare memory in a collection.
- `ArrayVec` initial implementation. This is mostly untested and many features missing,
  but a good skeleton to start with.

## [0.0.1] - 2021-11-20
### Added
`crates.io` placeholder.


[0.0.1]: https://github.com/r-bk/cds/releases/tag/v0.0.1
[0.0.2]: https://github.com/r-bk/cds/compare/v0.0.1...v0.0.2
[0.0.3]: https://github.com/r-bk/cds/compare/v0.0.2...v0.0.3
[0.0.4]: https://github.com/r-bk/cds/compare/v0.0.3...v0.0.4
[0.0.5]: https://github.com/r-bk/cds/compare/v0.0.4...v0.0.5
[0.0.6]: https://github.com/r-bk/cds/compare/v0.0.5...v0.0.6
[0.1.0]: https://github.com/r-bk/cds/compare/v0.0.6...v0.1.0
[0.2.0]: https://github.com/r-bk/cds/compare/v0.1.0...v0.2.0
[0.3.0]: https://github.com/r-bk/cds/compare/v0.2.0...v0.3.0
[0.4.0]: https://github.com/r-bk/cds/compare/v0.3.0...v0.4.0
[0.5.0]: https://github.com/r-bk/cds/compare/v0.4.0...v0.5.0
[0.6.0]: https://github.com/r-bk/cds/compare/v0.5.0...v0.6.0
[0.7.0]: https://github.com/r-bk/cds/compare/v0.6.0...v0.7.0
[0.8.0]: https://github.com/r-bk/cds/compare/v0.7.0...v0.8.0
[0.8.1]: https://github.com/r-bk/cds/compare/v0.8.0...v0.8.1
[0.9.0]: https://github.com/r-bk/cds/compare/v0.8.1...v0.9.0
[0.10.0]: https://github.com/r-bk/cds/compare/v0.9.0...v0.10.0