Skip to content

History.md

Latest commit

 

History

History
179 lines (168 loc) · 15.1 KB

History.md

File metadata and controls

179 lines (168 loc) · 15.1 KB

BitSerializer (History log)

What's new in version 0.85: (11 Jan 2026):
  • [ ! ] Introduced deserialization postprocessors (Fallback, TrimWhitespace, ToLowerCase, ToUpperCase).
  • [ ! ] Added the ability to pass through the payload of raw data structures (thanks @hoshinohikari for the idea!).
  • [ + ] Added new serialization option trimStringFields (automatically trims whitespace from all string fields).
  • [ + ] Added new sample payload_passthrough; see also the corresponding section in README.md.
  • [ * ] Reworked all comments in Doxygen style.
  • [ * ] Added prefix BITSERIALIZER_ to the enum registration macros: REGISTER_ENUM and DECLARE_ENUM_STREAM_OPS.
  • [ * ] Moved some header files containing public types to the root directory of bitserializer.
  • [ * ] Fixed typo where the alias for MaxSize was incorrectly named Validate::MinSize (thanks @mattlutz-acre).
  • [ * ] Changed OverflowTypeException to MismatchedTypeException when attempting to load a negative value into an unsigned type.
  • [ * ] [Convert] Changed exception type to invalid_argument when attempting to convert a negative value to an unsigned type.
  • [ * ] [CSV] Optimized deserialization performance (+22% faster from memory and +32% faster from stream).
  • [ * ] [MsgPack] Fixed crash in certain cases when loading corrupted MsgPack data (caused by a nested exception).
  • [ * ] [CSV, PugiXml, RapidYaml] Fixed cross-platform compatibility for serializing special floating-point values (INF, NAN).
  • [ * ] [RapidJson, PugiXml, RapidYaml] Fixed loading of optional objects and arrays from null values (thanks @mattlutz-acre).
What's new in version 0.80: (3 May 2025):
  • [ ! ] Improved code quality and sanity check of commits with helping ClangTidy and Valgrind.
  • [ ! ] Changed the priority of serialization methods, the internal Serialize() method will have a higher priority than the global one.
  • [ ! ] Validators were moved to namespace BitSerializer::Validate for avoid conflicts when using namespace BitSerializer.
  • [ + ] Added support building a shared (dynamic) library type.
  • [ + ] Added visualization of benchmarks and testing serialization to STD streams.
  • [ + ] Added support for serialization of class hierarchy when the base class uses global SerializeObject() function.
  • [ + ] Added extra arguments into Convert functions (can be used to pass an allocator or an existing string).
  • [ * ] Fixed issue with serialization custom arrays, related to detection size() function (thanks @marton78).
  • [ + ] Added new sample serialize_custom_array and new related chapter in the "README.md".
  • [ * ] Optimized loading into std containers.
  • [ + ] Added publishing of binaries to GitHub releases.
  • [ * ] Rewritten Hello world! example to better demonstrate the library's capabilities.
  • [ * ] [CSV] Fixed reading escaped values from std::istream.
  • [ * ] [MsgPack] Fixed serialization std::tuple (thanks @marton78).
  • [ * ] [MsgPack, RapidJson] Fixed serialization of long, unsigned long types (not compiled on all platforms).
  • [ * ] [RapidJson] Fixed serialization of std::unordered_map and std::unordered_multimap.
  • [ * ] [RapidJson] Fixed loading null to string type, now it will not lead to MismatchedTypes error (similar to numbers).
  • [ * ] [RapidYaml] Added support for the latest released library v0.8.0 (+70% to performance and now works on ARM).
  • [ - ] Removed deprecated CppRestJson archive, please use RapidJson instead.
  • [ - ] Removed deprecated classes and functions - Version, MakeKeyValue, AutoKeyValue, MakeAutoKeyValue.
  • [ - ] Removed deprecated classes and functions - MakeAttributeValue, AutoAttributeValue, MakeAutoAttributeValue.
What's new in version 0.75: (05 Jan 2025):
  • [ ! ] Added support ARM architecture (including platforms with big-endian byte order).
  • [ + ] Added new option SerializationOptions::utfEncodingErrorPolicy for configure handling of UTF encoding errors.
  • [ + ] Added support for serialization types: std::unordered_multiset, std::unordered_multimap, std::u8string (C++20).
  • [ + ] Added optional overwrite flag to SaveObjectToFile() function (false by default).
  • [ + ] Added PhoneNumber validator.
  • [ * ] Fixed saving of constant values (thanks @marton78).
  • [ * ] Fixed serializing std::set, std::multiset, std::unordered_map and std::unordered_multimap with custom allocator.
  • [ * ] [Convert] Improved UTF encoders, they will return more details about errors.
  • [ * ] [Convert] Moved all UTF encoders and related code into sub-namespace BitSerializer::Convert::Utf.
  • [ * ] [RapidJson] Fixed conflict with GetObject macro from Windows headers (thanks @psallandre).
  • [ * ] [PugiXml] Slightly improved performance of saving to stream.
  • [ - ] [CppRestJson] JSON archive based on CppRestSdk library is deprecated, please use - JSON archive "bitserializer-rapidjson".
What's new in version 0.70 (31 May 2024):
  • [ ! ] Added new archive for serialization to MsgPack (built-in implementation, no dependencies).
  • [ ! ] Improved performance for all archives (sufficiently for CSV).
  • [ ! ] Deprecated AutoKeyValue and AutoAttributeValue (use regular KeyValue and AttributeValue for all cases).
  • [ ! ] Deprecated Version structure, please use similar macros BITSERIALIZER_VERSION_*.
  • [ ! ] Optimized string serialization, especially for your own types (use internal function Detail::SerializeString()).
  • [ + ] Added support for serialization types: std::filesystem::path, std::atomic type, std::byte and std::valarray.
  • [ + ] Added config.h file with version macros and several other library options (disable std::filesystem, etc).
  • [ + ] Added EnumAsBin wrapper for able to serialize enum types as integers (registration is not required in this case).
  • [ * ] Implemented Overflow and Mismatched policies for std::chrono types serialization.
  • [ * ] Fixed handling mismatch types for cases when target value is array or object.
  • [ * ] Changed OverflowTypeException to MismatchedTypeException when try to load float to int.
  • [ + ] Added the ability to pass custom error messages to validators.
  • [ + ] Added email validator.
  • [ + ] Added new samples "msgpack_vs_json" and "versioning".
  • [ + ] Added new option maxValidationErrors to SerializationOptions.
  • [ * ] SerializationException with error code UnregisteredEnum will be thrown when serializing unregistered enum.
  • [ + ] [Convert] Added new API function IsConvertible<TIn, TOut>().
  • [ + ] [Convert] Use modern from_chars() and to_chars() for converting float types (if they available).
  • [ + ] [Convert] Allowed to convert any of fundamental types to any other fundamental type.
  • [ * ] [Convert] Fixed floating numbers conversion after failure due to overflow.
  • [ * ] [Convert] Increased number of significant digits for float from 6 to 7.
  • [ * ] [Convert] Changed exception type to invalid_argument when converting a string with floating point number to integer.
  • [ * ] [Convert] Fixed convert (and serialization) negative std::duration with fractions of second.
  • [ * ] Fixed compatibility with C++ 20.
  • [ - ] Removed deprecated REGISTER_ENUM_MAP.
  • [ * ] [RapidYaml] Replaced usages of deprecated API function (compatibility is preserved).
  • [ * ] [RapidYaml] Changed serialization of boolean values to "true|false", as in other archives (thanks @psallandre).
What's new in version 0.65 (12 September 2023):
  • [ ! ] The repository has been migrated to GitHub.
  • [ ! ] Added support serialization of chrono::time_point, chrono::duration and time_t.
  • [ ! ] Conversion sub-module: Added conversion of chrono::time_point, chrono::duration and time_t.
  • [ ! ] Functions MakeKeyValue and MakeAutoKeyValuewere marked as deprecated (please use constructors directly).
  • [ ! ] Functions MakeAttributeValue and MakeAutoAttributeValue were marked as deprecated (please use constructors directly).
  • [ + ] Added support serialization of std::tuple (as array in the target archive, cannot be used with CSV archive).
  • [ * ] Applied MismatchedTypesPolicy when serialization enum types.
  • [ * ] Applied Overflow and Mismatched types of policies when loading keys of map types.
  • [ * ] Fixed detection overflow of integers (uses for OverflowNumberPolicy).
  • [ * ] Fixed serialization of std::multimap (was broken in v.0.50).
  • [ * ] Optimized loading of std::unordered_map (pre-reserve size if possible).
  • [ * ] Change measurement units in the performance tests from kb/s to fields/ms.
  • [ - ] Removed deprecated global SerializationContext.
  • [ * ] [RapidJson, CSV] Optimized the performance.
What's new in version 0.50 (5 December 2022):
  • [ ! ] Added new archive for serialization to CSV, supports all UTF encodings with auto-detection (built-in implementation, no dependencies).
  • [ ! ] API breaking change - deprecated global BitSerializer::Context, now validation errors will propagate only via ValidationException.
  • [ ! ] Removed all static memory allocations for be compatible with custom allocators.
  • [ + ] Added policy OverflowNumberPolicy for case when size of target type is not enough for loading number.
  • [ + ] Added policy MismatchedTypesPolicy for case when type of target field does not match the value being loaded.
  • [ + ] Added default SerializationOptions.
  • [ * ] Added ParsingException with information about line number or offset (depending on format type).
  • [ * ] Added new simplified macro REGISTER_ENUM - replacement for REGISTER_ENUM_MAP which is deprecated.
  • [ + ] Conversion sub-module: Added error policy for encode UTF (error mark, throw exception or skip).
  • [ * ] Conversion sub-module: Added throwing invalid_argument exception when converting from invalid string to number.
  • [ * ] Conversion sub-module: Converting a string containing floating point number to integer, now will throw out_of_range exception.
  • [ * ] Conversion sub-module: Fixed work with raw pointers in the UTF-16Be and UTF-32Be encoders.
  • [ * ] Conversion sub-module: Fixed macro DECLARE_ENUM_STREAM_OPS (can't be used in namespaces).
  • [ * ] [CppRestJson] Fixed serialization of booleans in the object (was serialized as number).
  • [ * ] [RapidYaml] Fixed compatibility with latest version of the RapidYaml library (0.4.1).
  • [ * ] [RapidYaml] Fixed serialization negative int8.
  • [ * ] [RapidYaml] Fixed issue with error handling when multi-thread serialization.
  • [ * ] [RapidJson, CppRestJson, RapidYaml] Fixed path in the validation errors, index in arrays was shifted by 1.
What's new in version 0.44 (1 October 2021):
  • [ ! ] Changed minimum requirement for CLang compiler from version 7 to 8.
  • [ ! ] API breaking change - global Serialize() function should now return bool.
  • [ ! ] API breaking change - validation messages now storing in UTF-8, function GetValidationErrors() returns vector of std::string.
  • [ ! ] Simplified implementing non-intrusive serialization, now only one global function should be defined (compatibility is preserved).
  • [ ! ] Internal string conversion method FromString() now should have as argument any of std::string_view types instead of std::string.
  • [ - ] Internal string conversion method ToWString() was deprecated, please implement ToU16String() and/or ToU32String() when you needed.
  • [ + ] Conversion sub-module: added support for globally defined function To(in, out) for user's classes.
  • [ + ] Conversion sub-module: added support for globally defined function to_string(in) for user's classes.
  • [ + ] Implemented internal encoders for UTF-16 and UTF-32 (in the previous version there was only UTF-8).
  • [ + ] Added support for std::u16string and std::u32string in the convert sub-module.
  • [ + ] Added support serialization of std::u16string and std::u32string and ability to use them as keys.
  • [ + ] Added support serialization for C++ nullptr type (uses for serialization smart pointers).
  • [ + ] Added support serialization for std::optional type, std::unique_ptr and std::shared_ptr.
  • [ + ] Added new samples "string_conversions", "serialize_custom_string" and "serialize_map_to_yaml".
  • [ + ] Added documentation for string conversion submodule.
  • [ * ] Removed streams operators for enum and classes, now need to explicitly declare them via macro DECLARE_ENUM_STREAM_OPS.
  • [ * ] Update compatibility with new version of RapidYaml library v.0.1.0.
  • [ * ] Fixed handling YAML parse errors (previously was called abort() in the RapidYaml library).
  • [ * ] Fixed handling errors when loading incompatible types in PugiXml archive.
  • [ * ] Fixed saving temporary strings in RapidJson archive.
  • [ * ] Conversion sub-module: boolean type will be converted to "true|false" strings (please cast to if you expect "1|0").
Version 0.10 (1 June 2020):
  • [ ! ] Changed main concept with separate library for each format to all-in-one library with components.
  • [ ! ] Changed include paths for archives (all archive implementations are now in the "bitserializer" directory).
Version 0.9 (5 May 2020):
  • [ ! ] Added XML serialization support (based on library PugiXml).
  • [ ! ] Added YAML serialization support (based on library RapidYaml).
  • [ ! ] Add CI with builds for Windows, Linux (GCC, Clang) and MacOS (AppleClang).
  • [ + ] Add formatting options for output text (but formatting is not supported in CppRestJson).
  • [ + ] Add support encoding to various UTF based formats (defines in serialization options).
  • [ + ] Add optional writing the BOM to output stream/file.
  • [ + ] Add ability for pretty format of output text.
  • [ + ] Add UTF encoding when serializing std::wstring.
  • [ + ] Add serialization for all STD containers which were missed before.
  • [ + ] Add serialization C++ union type.
  • [ * ] Split implementation of serialization for std types into separate files.
  • [ * ] Change string type for path in archive from std::wstring to std::string (in UTF-8 encoding).
  • [ * ] For archive based on RapidJson was changed in-memory encoding from UTF-16 to UTF-8.
  • [ * ] Add path into exceptions about I/O errors with files.
  • [ * ] Fix registration enum types not in global namespace.
  • [ * ] Add constants with library version.

Version 0.8 (30 November 2018):

  • [ ! ] The package for VCPKG was split into two: "bitserializer" (core without any dependencies) and "bitserializer-cpprestjson" (requires "cpprestsdk").
  • [ + ] Added new implementation for JSON format based on library RapidJson (currently supported only UTF16).
  • [ + ] Added validation of deserialized values.
  • [ + ] Added performance test.
  • [ + ] Added directory with samples.
  • [ + ] Added CMake support (it needs just for samples and tests, as the library is headers only).
  • [ + ] Added function MakeAutoKeyValue() to make key/value which is able to automatically adapt key to target archive.
  • [ * ] Enhanced architecture for support different kind of formats (for example allow to implement ANSI/Unicode streams in one archive).
  • [ * ] Fixed compilation issues on latest Visual Studio 15.8.6 and GCC.
  • [ * ] Changed (unified) interface methods: LoadObjectFromStream() -> LoadObject(), SaveObjectToStream() -> SaveObject().

Version 0.7 (22 March 2018)

  • [!] First public release.