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

*Performance notes are approximated results from criterion benchmarking.*


## [v.0.3.2] - 2023-03-28

### Improved

- **Performance increase** on previous version of roughly **30%**.
  - Refactor of `Stack::tick`; now uses iterators instead of for loops.

## [v0.3.1] - 2023-02-01

### Improved

- **Performance increase** on previous version of roughly **20%**.
  - Refactor of `Stack::tick`; now uses only one vector instead of two.

## [v0.3.0] - 2023-01-30

### Added

- Shadowing: methods on `State`s that are always executed on a `Stack`'s `tick`,
even if the `State` is not at the top.
  - `on_shadow_tick` for when the stack gets ticked through its `tick` method.

## [v0.2.0] - 2023-01-28

### Added

- `Trans`
  - `Replace`: pops and pushes a new state, effectively performing a 
  replacement.
  - `Isolate`: quits and pushes a new state, effectively isolating it as the 
  only one on the stack.
  - Macros and functions on `Stack` for the new transitions.

## [v0.1.0] - 2023-01-27

- First public release of `solstack`.

### Added

- Fully capable state stack machine.
- `State` callbacks added on this version:
  - `on_start` for when a state is pushed.
  - `on_stop` for when a state is popped.
  - `on_pause` for when a state has another pushed on top.
  - `on_resume` for when a stated gets resumed due to the one above being pushed.
  - `on_tick` for when the stack gets ticked through its `tick` method.
- `Trans`
  - `Push` that pushes a new state on top.
  - `Pop` that pops the topmost state out.
  - `None` that does not change the stack.
  - `Quit` that pops everything out.
- Examples
  - `guessing_game`
- Tests
  - `callback_counting`