Releases: mapbox/protozero
Releases · mapbox/protozero
Version 1.6.1
Added
- Document internal handling of varints.
- Add aliases for fixed iterators, too.
Changed
- The
const_fixed_iterator
is now a random access iterator making code using it potentially more performant (for instance when usingstd::distance
) - Overloads
std::distance
for the varint and svarint iterators. This is better than the workaround with therage_size
function used before.
Fixed
- Rename
.proto
files in some tests to be unique. This solves a problem when building with newer versions of the Google Protobuf library. - Floating point comparisons in tests are now always correctly done using
Approx()
.
Version 1.6.0
Added
- Comparison functions (<, <=, >, >=) for
data_view
. Allows use instd::map
for instance. - Tool
pbf-decoder
for decoding raw messages. This has limited use for normal users, but it can be used for fuzzing.
Changed
- Protozero now uses CMake to build the tests etc. This does not affect simple users of the library, but if you are using CMake yourself you might want to use the
cmake/FindProtozero.cmake
module provided. The README contains more information about build options. - Moved
data_view
class fromtypes.hpp
into its own header filedata_view.hpp
. - Implementation of the
const_fixed_iterator
to use only a single pointer instead of two. - Made
operator==
andoperator!=
ondata_view
constexpr. - The
pbf_reader
constructor taking astd::pair
is deprecated. Use one of the other constructors instead.
Fixed
- Varints where the last byte was larger than what would fit in 64bit were triggering undefined behaviour. This can only happen when the message being decoded was corrupt in some way.
- Do not assert when reading too long varints for bools any more. A valid encoder should never generate varints with more than one byte for bools, but if they are longer that's not really a problem, so just handle it.
- Throw exception if the length of a packed repeated field of a fixed-length type is invalid. The length must always be a multiple of the size of the underlying type. This can only happen if the data is corrupted in some way, a valid encoder would never generate data like this.
- Throw an exception when reading invalid tags. This can only happen if the data is corrupted in some way, a valid encoder would never generate invalid tags.
Version 1.5.3
Added
- More documentation.
- New
size()
method on iterator range used for packed repeated fields to find out how many elements there are in the range. This is much faster compared to thestd::difference()
call you had to do before, because the varints don't have to be fully decoded. See Advanced Topics for details.
Changed
- Updated clang-tidy settings in Makefiles and fixed a lot of minor issues reported by clang-tidy.
- Update included catch.hpp to version 1.10.0.
- Miscellaneous code cleanups.
- Support for invalid state in
pbf_writer
andpacked_repeated_fields
. This fixes move construction and move assignement inpbf_writer
and disables the copy construction and copy assignement which don't have clear semantics. It introduces an invalid or empty state in thepbf_writer
,pbf_builder
, andpacked_repeated_fields
classes used for default-constructed, moved from, or committed objects. There is a newcommit()
function forpbf_writer
and thepacked_repeated_fields
which basically does the same as the destructor but can be called explicitly.
Fixed
- The
empty()
method of the iterator range now returns abool
instead of asize_t
.
Version 1.5.2
Added
- Add missing two-parameter version of
pbf_message::next()
function. - Add
data_view::empty()
function. - Add missing versions of
add_bytes()
,add_string()
, andadd_message()
topbf_builder
.
Changed
- Clarify include file usage in tutorial.
- Updated included Catch unit test framework to version 1.9.6 and updated tests to work with the current version.
- Make some constructors explicit (best practice to avoid silent conversions).
Fixed
- Important bugfix in
data_view
equality operator. The equality operator is actually never used in the protozero code itself, but users of protozero might use it. This is a serious bug that could lead to buffer overrun type problems.
Version 1.5.1
Added
- Better documentation for
tag_and_type()
in doc/advanced.md.
Fixed
- Fixed broken "make doc" build.
Version 1.5.0
Added
- Add
add_bytes_vectored()
methods topbf_writer
andpbf_builder
. This
allows single-copy scatter-gather type adding of data that has been prepared
in pieces to a protobuf message. - New functions to check the tag and wire type at the same time: Two parameter
version ofpbf_reader::next()
andpbf_reader::tag_and_type()
can be used
together with the free functiontag_and_type()
to easily and quickly check
that not only the tag but also the wire type is correct for a field.
Changed
packed_field_*
classes now work withpbf_builder
.- Reorganized documentation. Advanced docs are now under doc/advanced.md.
Fixed
packed_field
class is now non-copyable because data can get corrupted if
you copy it around.- Comparison operators of
data_view
now have const& parameters. - Make zigzag encoding/decoding functions constexpr.
Version 1.4.5
Fixed
- Undefined behaviour in packed fixed iterator. As a result, the macro
PROTOZERO_DO_NOT_USE_BARE_POINTER
is not used any more.
Version 1.4.4
Fixed
- Byteswap implementation.
Version 1.4.3
Fixed
- Undefined behaviour in byte swapping code.
- Rename some parameters to avoid "shadow" warning from some compilers.
Version 1.4.2
Fixed
- Compile fix: Variable shadowing.