# Changelog

## [v1.2.1] - 2023-02-12

### Added

- Notes added to doc comments referencing the Usage section of the landing page
  for methods affected by feature flags.

### Changed

- Fixed example code in doc comments to not depend on feature flags.

## [v1.2.0] - 2023-02-11

### Added

- Methods added to `LinkedVector`:
  - `cursor_front()`
  - `cursor_back()`
  - `cursor_front_mut()`
  - `cursor_back_mut()`
- `Cursor` & `CursorMut` now support the `Deref` and `DerefMut` traits, so
  pointer-like syntax is possible.
- The new feature flag, `"optionless-accessors"` has been added. With this
  enabled certain accessor methods of `LinkedVector` and `Cursor` return their
  respective values directly not wrapped in an `Option`.
- The new feature flag, `"cursor-remove"`, enables `CursorMut::remove()`. It
  is off by defaul. Users should explicitly enable if they want to use the 
  `remove()` command.
### Changed

- With the feature flag, `"optionless-accessors"` enabled, the following 
  `LinkedVector` methods no longer return an `Option` and return their 
  respective values directly:
  - `get()`
  - `get_mut()`
  - `remove()`
- With the feature flag, `"optionless-accessors"` enabled, the following 
  `Cursor`/`CursorMut` methods no longer return an `Option` and return their 
  respective value directy:
  - `get()`
  - `get_mut()`
- `Cursor::move_to()` with `"optionless-accessors"` doesn't return a value. The 
  handle passed to it is assumed to be valid, or expect a panic.
- `CursorMut::remove()` is now switched on with the `"cursor-remove"` feature 
  flag. It is off by default.

## [v1.1.0] - 2023-02-10

### Added

- `Hash` implemented for `LinkedVector`.
- `Debug` friendly string representation implemented for `LinkedVector`.
- More methods added to `LinkedVector`:
  - `next_value()` allows accessing the value after the given node.
  - `next_value_mut()` allows mutable access to the value after the given node.
  - `prev_value()` allows access to the previous value of the given node.
  - `prev_value_mut()` allows mutable access to the value before the given node.

### Changed

- `Cursor::move_to_start()` is deprecated, use `move_to_front()` instead.
- `Cursor::move_to_end()` is deprecated, use `move_to_back()` instead.

## [v1.0.0] - 2023-02-09

### Added

- `compact()` method added to `LinkedVector` that produces a new compacted 
  vector.
- `LinkedVector` gets new stable sort methods: `sort()`, `sort_by()`, and 
  `sort_by_key()`.

### Changed

- The unstable sort methods reimplemented to use Rust's standard library's built 
  in sorting routines.

### Removed

- `LinkedVector::swap()` removed since the sort methods no longer need it.

### Fixed

- Issue where expired handles weren't detected if the node had been recycled.


## [v0.3.0] - 2023-02-08

### Added

- `CursorMut::insert()` & `CursorMut::insert_after()`
- `CursorMut::remove()`

### Changed

- Methods that take a `usize` index have been removed to encourage the O(1) use
  of handles to locate data, and to simplify the naming conventions of methods.  
- The following methods have been changed:
  - `handle_at()` is now just `handle()`
  - `cursor_at()` is now `cursor()`, the old `cursor()` is removed.
  - `cursor_at_mut()` is now `cursor_mut()`, the old `cursor_mut()` is removed.
  - `insert_before()` is now `insert()`, the old `insert()` is removed.
  - `remove_node()` is now `remove()`, the old `remove()` is removed.
  - `remove_value()` is removed.

## [v0.2.0] - 2023-02-07

### Added

- A new `remove()` that takes the index of the item to remove.
- An `insert()` that takes the index of the position to insert to, and the value
  to insert.
- `get_handle()`, which returns the handle of the `index`'th item.

### Changed

- Changed the name of `remove()` to `remove_value()`. 

## [v0.1.5] - 2023-02-07

### Fixes

- Fixed issue with detection of expired handles.

## [v0.1.4] - 2023-02-07

### Added

- Changelog created.
- Detection of expired handles for debug build.

### Changed

- README.md updated.
- Comments updated with more tests/examples for sorting.