Releases: jam1garner/binrw
Releases · jam1garner/binrw
Version 0.15.0
Breaking changes
- The generic parameter lists for
binrw::helpersfunctions have been reordered to put most-frequently-used parameters first. - Lifetime parameters have been added to several
binrw::helpersfunctions to support borrowed arguments. - The MSRV has been increased to 1.70.
- Parsing a unit enum with
magicwill now return anIo(UnexpectedEof)error when all attempts to read magic result in anUnexpectedEof. Previously, this would returnNoVariantMatch. (#324, #325. Thanks, @plaflamme!)
Enhancements
PosValuenow includes implementations forDefaultandBinWrite. TheBinWriteimplementation simply treatsPosValueas a wrapper and writes the stored value in place; theposfield is ignored. Use theseek_beforeand (optionally)restore_positiondirectives if you want to write aPosValuevalue to a different position in the output stream. (#270, #273. Thanks, @amirbou!)- binrw now uses syn 2 internally, which should reduce the build time for most users of binrw when used with other dependencies that have also updated to syn 2. (#285, #299. Thanks, @Urist-McGit!)
- The amount of code generated has been reduced, improving compilation times. (#319. Thanks, @ScanMountGoat!)
- Various small documentation improvements. (Thanks, @marxin!)
BinWrite::write_neandBinWrite::write_ne_argsconvenience functions have been added to match the same functions in theBinReadAPI.- The owo-colors dependency has been updated to version 4.
Bug fixes
- Using
SeekFrom::EndwithTakeSeeknow correctly seeks relative to the end of the stream if the stream is shorter than the limit. (#291) - Using
binrw::helpers::count_withto return aVec<{integer}>using a custom function will no longer ignore the custom function. (#318. Thanks, @kitlith!) - It is now possible to pass borrowed values when using
binrw::helpersfunctions. - The
argsdirective can now be used when closures are passed toparse_withorwrite_with. - All forwarding calls in the
BinReadExtandBinWriteExttraits are now appropriately annotated with#[inline].
Contributors
plaflamme, marxin, and 4 other contributors
Assets 2
Version 0.14.1
Bug fixes
- Passing a
SeekFrom::EndtoTakeSeek::seeknow correctly seeks from the end of theTakeSeekstream instead of the end of the inner stream. (#291)
Version 0.14.0
Breaking changes
- In derived
BinWriteimplementations, imported variables are now exposed before field variables, to match the way lexical scoping normally works. If an import and a field have the same name, this will cause the import to be shadowed. Previously, the field would be shadowed.
Enhancements
- Diagnostic output is improved when using
parse_withandmaptogether in an incompatible way.
Bug fixes
- It is now possible to use a mix of generic and concrete types in
BinWritederives without triggering a type mismatch error. - It is now possible to use the anonymous lifetime
'_within nested types inside animportdirective. (#241) - The compiler will no longer panic when
verbose-backtraceis enabled and a derived type contains a docblock with a completely empty line. (#263) - Generated code will no longer trigger
clippy::unnecessary_fallible_conversionslints.
Version 0.13.3
Bug fixes
- Using
parse_with/write_with,map_stream, andargstogether will no longer raise an error about incompatible stream types. (#240)
Version 0.13.2
Bug fixes
Using parse_with with map/try_map will no longer raise an error about incompatible types when the types are actually compatible. (#239)
Version 0.13.1
Bug fixes
- Using
streamdirective together withmap_streamno longer causes a borrowck error. (#236)
Version 0.13.0
Breaking changes
- The stream specified by
map_streamis now only used when reading the inner value(s) of the field/struct/enum it is applied to. Previously, the mapped stream would also be used for magic, padding, etc. when those directives were also applied to the same field or type, but this caused problems with re-borrowing the stream and made the scope of the directive confusing.
New features
- Helper functions for reading and writing unsigned 24-bit integers have been added.
Bug fixes
- It is now possible to use
map_streamwithcountwithout causing a borrowck error. - It is now possible to pass args to a
parse_withfunction that is notCopywithout causing a borrowck error. (#185) - It is now possible to derive
BinWriteon a type whose associatedArgstype implementsDefaultbut is not the unit type. (Thanks, @octylFractal!) - It is now possible to use
PhantomData<T>withBinWritewhereTis notBinWrite. (Thanks, @DCNick3! #230) - Calling
custom_erron an error with a backtrace will now correctly return the original custom error. (#228) - Rust compiler and dependency versions have been updated to the correct minimum versions. (#224)
- Calling
Error::custom_errwill now always return the custom error even if there is a backtrace associated with it. (#228) - Using
selfin top-level#[bw]directives now works as expected. (#232) #[bw(assert)]now actually emits assertions on enums and data enum variants instead of silently accepting the directive without emitting any code.
Contributors
octylFractal and DCNick3
Assets 2
Version 0.12.0
Breaking changes
- The default behaviour of
FilePtrhas been changed to always immediately seek to and read the pointed-to value. Helper functions have been added to thefile_ptrmodule to support the common case of reading from an offset table. Additional helper functions and types will be added in future releases to improve support for file indirection. - The
BinRead::after_parseAPI has been removed since it was rarely used, usually broken by manualBinReadimplementations, and made it impossible to use borrowed values in arguments in some cases. For custom two-pass parsing, one alternative is to create an object that will store data that need to be used during the second pass, pass a mutable reference to that object as an argument toread_options, add data to that object during the first pass, then use the recorded data from the object to perform the required action for the second pass. deref_now,offset_after, andpostprocess_nowhave been removed as they were designed to control theafter_parseAPI which no longer exists. Any field with aderef_noworpostprocess_nowdirective can simply remove the directive to achieve equivalent functionality. Any struct that usedoffset_aftershould reorder the fields so the dependent field is after the offset location.
For more detail on these changes, see #210.
- Selected helper functions are no longer re-exported to the root of the crate. Access these helper functions, plus all the other helper functions that were never re-exported to the root, from the
helpersmodule. - Using the undocumented internal variable
thisfrom anassertdirective is no longer supported. Replacethiswith the supportedselfkeyword instead.
New features
- Helper functions for more efficient reading of offset tables have been added to the
file_ptrmodule. These helpers can be combined with theseek_beforedirective to support both relative and absolute positioning of the pointed-to data. See the documentation for usage information and examples. assertdirectives on structs, non-unit enums, and data variants can now access the constructed object using theselfkeyword. (Thanks, @octylFractal!) (#219)
Enhancements
Cloneis no longer a required trait for arguments passed toparse_withfunctions. (Thanks, @octylFractal!)Cloneis no longer a required trait for arguments passed toBinReaderExtmethods.BinReadis no longer a required trait for dereferencing a value fromFilePtr. (#218)mapandtry_mapfunctions can now mutably borrow values.dbgnow also prints information about any padding and alignment directives on a field.- Various documentation improvements.
Bug fixes
- The
countdirective no longer attempts useless conversions. (Thanks, @poliorcetics!) (#206) dbgnow returns the correct position of a field when usingpad_beforeoralign_before. (#188)- Parser errors are no longer discarded if a stream rewind fails. (#215)
- Implementation details of binrw will no longer cause borrow checker failures when passing borrowed arguments to child objects.
Contributors
octylFractal and poliorcetics
Assets 2
Version 0.11.2
Bug fixes
#[binrw::parser]and#[binrw::writer]now correctly handle receiving a single argument (thanks, @octylFractal!)#[br(count)]now returns an error if the given count is out of range instead of usingunwrapand panicking (#194)
Contributors
octylFractal
Assets 2
Breaking changes
- Enums variants using
#[br(magic)]with mixed data types (i.e.enum Foo { #[br(magic(0_u8))] A, #[br(magic(1_i16))] B }) will now always parse top-to-bottom. Previously, variants would be parsed in groups by type. To maximise performance when parsing enums with mixed magic types, make sure variants with the same magic data type are contiguous. (Thanks, @MrNbaYoh!) - The
BinrwNamedArgsmacro and trait have been renamed toNamedArgs. - The
ReadOptions::offsetfield has been moved and is now a named argument specific to theFilePtrtype. The#[br(offset)]and#[br(offset_after)]directives will continue to work without any change, but manual uses ofFilePtrmust now pass the offset in arguments instead of options. ReadOptionsandWriteOptionshave been removed and replaced with a singleEndianparameter.- The
Argsassociated type now takes a lifetime to support borrowed arguments. Custom helper functions that don’t need to support borrowed arguments can use the'staticlifetime to maintain the previous behaviour.
New features
- The
#[br(dbg)]directive can be used for quick and dirty debugging output tostderr. (Thanks, @Swiftb0y!) (#50, #162) - The
args_iterhelper can be used for parsing any field where each item is parsed using a value from another iterator as an argument (e.g. an object containing a list of header entries, followed by a list of body entries, where each body entry requires data from the corresponding header entry to be parsed.) - The
TakeSeekreader adapter is a seekable version of thestd::io::Takeadapter. Use it by importing theTakeSeekExttrait and callingtake_seekon anyRead + Seekstream. - The
#[binrw::parser]and#[binrw::writer]attributes simplify the creation of functions compatible with theparse_withandwrite_withdirectives. - The
#[brw(try_calc)]directive adds a fallible version of the existingcalcdirective. - Add directives for accessing and remapping streams by @csnover in #174 (
#[brw(map_stream)])
Enhancements
- It is now possible to use references in imports/arguments.
- Rendering of errors can now be controlled using the
verbose-backtracecrate feature (enabled by default). Disabling this feature removes extra decorations, ANSI codes, and source text from the built-in error formatting. - The no-std implementation of
Cursornow overridesSeek::stream_positionfor improved performance using that API. - More useful error messages are now given when an
argsdirective is missing from a field that requires it. (#67, #76) - Combining
#[binread]and#[binwrite]on a struct or enum is now equivalent to just using#[binrw]. Previously, this was an error. - Assertion failures without explicit error messages in
#[br(assert)]directives now cause clearer error messages that explicitly state that an assertion failed. Previously, only the expression that failed to assert was given in the output.
Bug fixes
- The no-std implementation of
Cursornow actually seeks when usingSeekFrom::End. - End-of-file I/O errors are now correctly detected in all cases. (#125)
#[br(try)]now only constructs a default value when parsing actually fails.- Errors in
assert,count,offset,offset_after, andparse_withdirectives now point correctly at the source of the error.
Contributors
csnover, Swiftb0y, and MrNbaYoh