# 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).

## [Unreleased] - YYYY-MM-DD

## [0.2.4] - 2024-08-31
### Changed
- Made small documentation and code style improvements.
- Updated dev-dependency on [quickcheck] to 1.0.
- Updated MSRV to 1.68.0.
- Updated edition to 2021.

## [0.2.3] - 2020-11-28
### Changed
- Made small documentation and code style improvements.

## [0.2.2] - 2020-04-27
### Changed
- Improved documentation somewhat.
- Tightened bounds on maximum mangled size.
- Decreased run time of mangling by about 5-8%.

### Removed
- Removed `ManglingResult` type alias.

## [0.2.1] - 2020-04-19
### Added
- Guaranteed certain bounds on mangled-name lengths.

### Changed
- Refactored the C-compatible code and its tests into a separate module.
  Although this technically moves the `mangling_mangle` and `mangling_demangle`
  files to a new path and they become inaccessible at an old one (so this could
  be considered a breaking interface change), those functions are intended to
  be used only in their `no_mangle` form, from C, so this is being treated as a
  minor, non-breaking change.

### Fixed
- Guarded against overflowing multiplication when demangling unreasonable inputs.

## [0.2.0] - 2020-04-17
### Added
- Introduced a C-compatible interface (`mangling_mangle` and `mangling_demangle`).

### Changed
- Generalized the `mangle` interface to accept `Borrow<u8>` instead of just `u8`.

## [0.1.1] - 2020-04-10
### Changed
- Improved formatting of README.md to be more navigable.
- Updated dev-dependency on [quickcheck] to 0.9.

## [0.1.0] - 2020-04-10
### Added
- Initial public release on [crates.io], based on history extracted from [tyrga].

[crates.io]: https://crates.io
[quickcheck]: https://github.com/BurntSushi/quickcheck
[tyrga]: https://github.com/kulp/tyrga