Changelog

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

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[0.2.0] - 2025-09-25

Optional debug-guards feature flag that enables runtime assertions for relative pointer integrity without impacting release builds.
Added SelfRefCell::try_get / try_get_mut for safe readiness checks without invoking unchecked pointer reconstruction.
Documentation for Miri and AddressSanitizer workflows, including explicit failure modes and nightly command snippets.
SelfRefCell::try_get and SelfRefCell::try_get_mut so callers can detect uninitialised state without triggering undefined behaviour.
Miri support for testing self-referential data structures.

SelfRef equality now compares offset and metadata rather than struct addresses, aligning behaviour with user expectations.
Debug assertions now validate absolute pointers only when explicitly requested via from_parts_with_target, ensuring regular builds stay lean.

Guard handling during mutable access ensures pointers are re-sealed on drop, preventing accidental reuse of stale offsets after interior mutation.

Initial public release with SelfRef, SelfRefCell, metadata support for sized and unsized types, and Criterion benchmarks.