Version 0.10.0

[jam1garner]

Breaking changes

• The read_bytes helper, deprecated since 0.2.0, has been removed. Use Vec<u8> directly.

• The NullString and NullWideString APIs have been rewritten to use only standard Rust traits:

  before 0.10	as of 0.10
  T::from_string(s)	From<String> or From<&str>
  s.into_string()	s.to_string() or Display trait
  s.into_string_lossless()	TryFrom<T> for String trait

• Two BinWrite API functions have been renamed for consistency with the BinRead API:

  before 0.10	as of 0.10
  BinWrite::write_to(...)	BinWrite::write(...)
  BinWrite::write_with_args(...)	BinWrite::write_args(...)

New features

• The BufReader wrapper significantly improves performance when reading from non-memory streams (Add BufReader wrapper with performance enhancements #141)
• The NoSeek wrapper enables reading and writing non-seekable streams (Remove hard-dependency on Seek #6, Add NoSeek wrapper type for io::Read -> io::Read + io::Seek #78)
• Non-zero integer types are now supported by BinRead, BinWrite, and FilePtr (NonZeroXXX integers #134)
• Added performance tips to the documentation (Add "how to optimize parsers" documentation #130)

Enhancements

• binread, binrw, and binwrite attributes are now also part of the binrw prelude
• Improved performance reading integer primitives into collections (e.g. Vec<u32>) (Performance: binrw very slow when parsing Vec<i8> #129)
• The if directive is now also supported in #[bw] attributes (Add bw(if(expr)) and brw(if(expr)) to skip writing conditionally #113, Implement if directive for writes #146)
• Tuples can now use any args type that implements Clone
• Error messages are now clearer when count and args are incorrectly combined, or when passing the wrong type to args (br(count = ...) conflicts with br(args(...)) #112)
• More impls have been added to the no_std implementations of the Read and Write traits to improve feature parity with the std implementations
• The Debug implementations of NullString and NullWideString no longer allocate memory
• Documentation has been generally improved (Add documentation to VecArgs #75, Improve documentation for BinrwNamedArgs #76, Documentation improvements #103, Basic performance documentation #142)
• Write support is now fully documented
• Enum error handling modes are now documented

Bug fixes

• Using try_map = {closure} on a struct now generates valid code
• Errors in args directives now point to the correct location of the problem
• The optimised impl BinWrite for Box<[u8]> is now actually selected by the compiler
• Using named arguments no longer triggers clippy warnings about missing docs (Deriving BinRead with named arguments fails to compile with #![deny(missing_docs)] #124)
• Trailing commas no longer cause parsing errors in binrw::args!
• NullString and WideNullString types are now correctly marked with Eq
• Enum variants no longer sometimes unintentionally inherit directives from the parent enum
• Deriving BinWrite on unit structs no longer causes a panic
• pre_assert directives now correctly apply to unit enum values
• Line numbers in verbose backtraces are now correctly padded when the number of digits in the line number increases

---

This discussion was created from the release Version 0.10.0.