PKBuffer is a simple but flexible buffer library that allows you to cast Rust objects onto a byte buffer. It was born of multiple memory parsing scenarios such as executable header parsing and game ROM memory mapping. Its name comes from the magic that is casting arbitrary structure definitions at byte buffers and the fact that I was reverse engineering the game EarthBound at the time.
You can read the documentation here, and see various use examples in the test file.
fixed the undefined behavior of ref_to_bytes and similar functions by taking inspiration from bytemuck and actively preventing undefined behavior, thanks to @repnop for reporting this! this changes the generic signatures to have the trait Castable (e.g., T: Castable) in multiple functions. see the docs for more details!
objects acquired by get_ref and similar functions now require the Castable trait. this guarantees the safety of types acquired from byte buffers, see the docs for more details.
Castable comes alignment awareness. however, there are some cases (such as with PE files) where reading unaligned structures is necessary. as a result, Buffer::get_ref_unaligned, Buffer::force_get_ref and similar functions have been added to deal with unaligned objects.Castable trait can be derived for any struct given it meets the requirements, see the docs for more details.This version makes major changes! The Buffer struct is now a trait, and the struct has been converted to PtrBuffer. This simplifies the code and unifies the featureset without having to repeat code all over the place. Additionally, it gives the user the ability to define their own Buffer object.
IntoIter was returning references when it should be returning values, this is fixed.Error now implements Send and Sync.
Buffer is now a trait, which allows the featureset of both VecBuffer and the new PtrBuffer to be unified.
Error now makes use of the into() function with regards to std::io::Error.Buffer object was not getting updated on clone in VecBuffer. That's now fixed.
Buffer::search and similar functions now return an iterator to all search results, including no search results.
u8 pointer