From b85a987a56602c7733e3f8a86990a33644a97bf5 Mon Sep 17 00:00:00 2001 From: iximeow Date: Fri, 6 Aug 2021 00:23:46 -0700 Subject: add `AnnotatingDecoder`, supporting definitions, and a doc about it --- CHANGELOG | 11 +++++++++++ 1 file changed, 11 insertions(+) (limited to 'CHANGELOG') diff --git a/CHANGELOG b/CHANGELOG index 1683fec..2ffb6d6 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -2,6 +2,17 @@ TODO: Reader::next_n should return the number of items read as Err(ReadError::Incomplete(n)) if the buffer is exhausted TODO: Reader::offset should return an AddressDiff
, not a bare Address +TODO: impls of `fn one` and `fn zero` so downstream users don't have to import num_traits directly + +## 0.2.6 + +added `AnnotatingDecoder` and associated traits `FieldDescription` and `DescriptionSink` for architectures to report meanings for bit ranges in decoded instructions. + +added `NullSink`, with an `impl DescriptionSink for NullSink` - `NullSink` can always be used to discard instruction annotations. this is mostly useful for shared annotating and non-annotating decode logic. + +added a `docs/` directory for `yaxpeax-arch`: trip reports for `yaxpeax-arch` design. if `yaxpeax` eventually grows an RFC process one day, these are the kind of changes that would get RFC'd. + +added `docs/0001-AnnotatingDecoder.md`, describing motivation and implementation notes of `AnnotatingDecoder`. ## 0.2.5 -- cgit v1.1