rkyv

This bugfix release fixes a minor issue with deserializing strings in certain configurations, deprecates #[archive(repr(...))] in favor of #[archive_attr(repr(...))], and fixes support for using multiple repr arguments simultaneously (#184, i.e. repr(C, packed)).

Thanks to @Diomendius for reporting this bug!

This bugfix release fixes some tests that made assumptions about platform atomic support.

This bugfix release contains the following changes:

• Fixes some broken links in the docs and README
• #177 Adds the AsVec wrapper for associative containers
• #170 #173 Adds new Debug impls for builtin types and improves existing ones
• #179 Publicizes some ArchivedString internals to allow other crates to use them

Thanks to everyone who filed issues and feature requests.

This bugfix release adds the new AsOwned wrapper type to allow users to serialize Cows and points URLs to the new github repo and book pages.

This bugfix release corrects some ArchiveCopySafe impls that were not marked unsafe. Thanks @PonasKovas for reporting the issue!

This bugfix releases fixes the tinyvec integration since the addition of scratch space. Thanks @Kixiron for reporting the issue!

This bugfix release contains no code changes, but copies the license file into the individual crates and corrects an incorrect line ending for packaging on Fedora.

0.7 is the seventh major release of rkyv. This release focused on filling out rkyv's feature set and providing commonly-requested features. This is intended to be the final major feature release before stabilizing for 1.0.

Features

• #104 rkyv now natively supports endian-agnostic types using the rend crate.
• #129 Added support for 16-bit archives to complement the existing 32- and 64-bit support.
• #108 Serialization and validation performance has been improved significantly. Strings have been given an optimized inline form to reduce memory usage.
• #107 Added support for no_std validation. In many cases, the alloc crate will be required.
• #126 Added support for no_std containers. In many cases, the alloc crate will be required.
• #152 Added the crate attribute to allow using rkyv from a different dependency name.
• #145 resolve is now unsafe with proper safety documentation.
• #122 Transparent field wrappers can now be used to easily customize archived types with #[with(...)].
• #127 Attributes can now be more easily added to generated archived types using #[archive_attr(...)].
• #128 Types which archive to other types can be derived using #[archive(as = "...")].
• #133 Multibyte fieldless enums are now supported, and multibyte enums with fields can be used with the arbitrary_enum_discriminant feature.
• #119 ArchiveCopy is now behind a feature and can automatically implement itself with a feature.
• #112 Archive derives now support the repr argument.

Library

• #130 Dependencies on the memoffset crate have been removed in favor of standard library alternatives.
• #158 Implemented more traits for ArchivedHashMap to bring it closer in line with HashMap.
• #154 Added archived BTreeMap and BTreeSet implementations optimized for IO.
• #135 Support for PathBuf has been added using the ToString wrapper.
• #120 Support for Mutex and RwLock has been added using the Lock wrapper.
• #160 Support for AtomicUsize and AtomicIsize has been added. Atomics now archive as non-atomic types by default. They can be archived as true atomics using the Atomic wrapper.
• #136 Support for CStr and CString has been added.
• #125 Standard library types now always deserialize using the Global allocator.

External crates

• #150 Added support for the indexmap crate with custom archived IndexMap and IndexSet implementations.
• #88 Added support for the uuid crate.
• #110 Added support for the tinyvec crate.

Special thanks

Thanks to everyone who contributed by filing issues, providing implementations, and being active members of the discord. Special thanks to some of the especially active members:

• namibj
• kixiron
• ChillFish8
• andrew

This is a pre-release of 0.7. The changelist for 0.7 will be as follows:

0.7 is the seventh major release of rkyv. This release focused on filling out rkyv's feature set and providing commonly-requested features. This is intended to be the final major feature release before stabilizing for 1.0.

Features

• #104 rkyv now natively supports endian-agnostic types using the rend crate.
• #129 Added support for 16-bit archives to complement the existing 32- and 64-bit support.
• #108 Serialization and validation performance has been improved significantly. Strings have been given an optimized inline form to reduce memory usage.
• #107 Added support for no_std validation. In many cases, the alloc crate will be required.
• #126 Added support for no_std containers. In many cases, the alloc crate will be required.
• #152 Added the crate attribute to allow using rkyv from a different dependency name.
• #145 resolve is now unsafe with proper safety documentation.
• #122 Transparent field wrappers can now be used to easily customize archived types with #[with(...)].
• #127 Attributes can now be more easily added to generated archived types using #[archive_attr(...)].
• #128 Types which archive to other types can be derived using #[archive(as = "...")].
• #133 Multibyte fieldless enums are now supported, and multibyte enums with fields can be used with the arbitrary_enum_discriminant feature.
• #119 ArchiveCopy is now behind a feature and can automatically implement itself with a feature.
• #112 Archive derives now support the repr argument.

Library

• #130 Dependencies on the memoffset crate have been removed in favor of standard library alternatives.
• #158 Implemented more traits for ArchivedHashMap to bring it closer in line with HashMap.
• #154 Added archived BTreeMap and BTreeSet implementations optimized for IO.
• #135 Support for PathBuf has been added using the ToString wrapper.
• #120 Support for Mutex and RwLock has been added using the Lock wrapper.
• #160 Support for AtomicUsize and AtomicIsize has been added. Atomics now archive as non-atomic types by default. They can be archived as true atomics using the Atomic wrapper.
• #136 Support for CStr and CString has been added.
• #125 Standard library types now always deserialize using the Global allocator.

External crates

• #150 Added support for the indexmap crate with custom archived IndexMap and IndexSet implementations.
• #88 Added support for the uuid crate.
• #110 Added support for the tinyvec crate.

Special thanks

Thanks to everyone who contributed by filing issues, providing implementations, and being active members of the discord. Special thanks to some of the especially active members:

• namibj
• kixiron
• ChillFish8
• andrew

This is a pre-release of 0.7. The changelist for 0.7 will be as follows:

0.7 is the seventh major release of rkyv. This release focused on filling out rkyv's feature set and providing commonly-requested features. This is intended to be the final major feature release before stabilizing for 1.0.

Features

• #104 rkyv now natively supports endian-agnostic types using the rend crate.
• #129 Added support for 16-bit archives to complement the existing 32- and 64-bit support.
• #107 Added support for no_std validation. In many cases, the alloc crate will be required.
• #126 Added support for no_std containers. In many cases, the alloc crate will be required.
• #152 Added the crate attribute to allow using rkyv from a different dependency name.
• #145 resolve is now unsafe with proper safety documentation.
• #122 Transparent field wrappers can now be used to easily customize archived types with #[with(...)].
• #127 Attributes can now be more easily added to generated archived types using #[archive_attr(...)].
• #128 Types which archive to other types can be derived using #[archive(as = "...")].
• #133 Multibyte fieldless enums are now supported, and multibyte enums with fields can be used with the arbitrary_enum_discriminant feature.
• #119 ArchiveCopy is now behind a feature and can automatically implement itself with a feature.
• #112 Archive derives now support the repr argument.

Library

• #130 Dependencies on the memoffset crate have been removed in favor of standard library alternatives.
• #158 Implemented more traits for ArchivedHashMap to bring it closer in line with HashMap.
• #154 Added archived BTreeMap and BTreeSet implementations optimized for IO.
• #135 Support for PathBuf has been added using the ToString wrapper.
• #120 Support for Mutex and RwLock has been added using the Lock wrapper.
• #136 Support for CStr and CString has been added.
• #125 Standard library types now always deserialize using the Global allocator.

External crates

• #150 Added support for the indexmap crate with custom archived IndexMap and IndexSet implementations.
• #88 Added support for the uuid crate.
• #110 Added support for the tinyvec crate.

Special thanks

Thanks to everyone who contributed by filing issues, providing implementations, and being active members of the discord. Special thanks to some of the especially active members:

• namibj
• kixiron
• ChillFish8
• andrew

This bugfix release fixes the following issues:

• std is no longer pulled in by an updated ptr_meta
• The derives for Serialize and Deserialize now explicitly use ::core::result::Result to prevent local Result types from breaking the derives (thanks @adaszko!)
• no_std builds with specialization now function correctly again (thanks @PiDelport!)
• A crash cased by deserializing zero-length strings with jemalloc is now fixed (thanks @devongovett!)

Thanks to everyone who contributed fixes and filed issues!

This bugfix release corrects the std dependency in ptr_meta to avoid pulling in the standard library on no_std targets.

0.6.5 is a bugfix release with a few minor changes:

• Updated dependencies
• ArchivedHashMap::serialize_from_iter is now pub so users can leverage it in writing their own structures
• Atomic support has been improved for rkyv_dyn
• Auto traits have been implemented for AlignedVec
• Validation has been added for ArchivedDuration and other types have been switched to derived implementations

Thanks to everyone who contributed to this release!

0.6.4 is a bugfix release that switches some relative paths to absolute paths in macros. The minimum supported rustc version has also been bumped to 1.50, but these are due to changes from before this release.

0.6.3 is a bugfix release that fixes deriving traits for structs with const generic parameters and adds some helper functions for AlignedVec to convert it to Vec (#111).

v0.6.2 is a minor update that adds support for types from std::net. Thanks to @DBLouis for the implementations!

Newly supported types:

• Ipv4Addr
• Ipv6Addr
• IpAddr
• SocketAddrV4
• SocketAddrV6
• SocketAddr

v0.6.1 is a hotfix for #116.

Undefined behavior was being caused because slice::deserialize was returning a null pointer for empty slices and zero-sized types, which was used to construct a Box with from_raw. This is unsound behavior since Box stores its pointer internally as a NonNull. The problem is fixed by having deserialize return NonNull::dangling() instead. This typically only presented in release mode.

The release checklist has been updated to include running tests in release to prevent release-only issues in the future.

This minor release addresses a security flaw that leaked uninitialized memory through struct padding. The fix required an API change for resolving, but should have no performance impacts. Thanks to @as-com for reporting the issue.

Note that ArchiveCopy types may still leak uninitialized memory in their padding bytes, and should be avoided on types that contain large blocks of padding. In practice, this is usually only an issue for enums. You can still use these types safely by removing #[archive(copy)].

This minor release fixes an issue with AlignedVec that caused its Drop implementation not to deallocate memory.

This minor release provides more flexible serialization for BufferSerializer and adds AlignedSerializer, a new higher-performance serializer. It also cleans up some documentation and moves a few things around for tidiness.

Version 0.5 brings bugfixes, ergonomics improvements, and new features:

• #86 Type bounds for serialization and deserialization can now be specified with #[archive(bound(serialize = "...", deserialize = "..."))]
• #73 Inlining is now performed more aggressively, which leads to considerable performance gains on average
• #96 Switching unreachable! to unreachable_unchecked should give a few small performance gains
• #68 PartialEq and PartialOrd can now be implemented between original and archived types with #[archive(compare(PartialEq, PartialOrd))]
• #82 A number of issues with derives have been fixed after a refactor and cleanup pass
• #95 Safety documentation has been normalized and clarified
• #93 Const generics support has been enabled by default. It can be turned off for compatibility with older versions by removing the const_generics default feature
• #91 A few existing functions have been renamed to clarify what they do and their relationships to other types
• #92 Helper functions have been added to get root objects without storing position

Thanks to everyone who provided suggestions and pull requests!

This release brings a few small features and a bugfix:

• The AlignedVec helper has been added, making it easier to ensure that byte buffers are properly aligned when accessing and deserializing. Docs have been updated to use AlignedVec where needed. Note that Vec is still perfectly fine for serializing and writing.
• Debug assertions have been added to archived_value and related functions to ensure that the buffer provided is properly aligned for the root type. This doesn't ensure that the entire buffer is properly aligned for all types inside it, use check_archive to ensure that.
• #89 An issue with deserializing 0-length slices, strings, and vectors has been fixed. This doesn't seem to have occurred under the default allocator but could with jemalloc and others.

This release includes a few minor features and a bugfix:

• #83 (possibly) Archive alignments are now validated along with type alignments
• #81 Adds an Archive implementation for core::time::Duration
• #79 Adds the Infallible type to make it easier to deserialize types that cannot fail

This hotfix update fixes no_std support and some dependency issues in the test crate that were preventing it from being properly tested.

This release changes some major APIs and adds shared pointer support:

#32 Introduces new context traits in place of the previous context struct. #33 Allows serialization parameterization over the type of the serializer, allowing users to choose the complexity of their serializers and create their own. #34 Renames Unarchive to Deserialize. #35 Splits Archive into Serialize to allow a clean hierarchy while still enabling parameterization. #39 Removes the Resolve trait and simplifies the API. #37 Performed some cleanup on the rkyv_dyn API. #36 Added shared and weak pointer support. #41 Added validation support for shared and weak pointers. #40 Added deserialization contexts to match serialization and verification contexts. #47 Introduced Serializers and Deserializers. #42 Added an attribute to rename the resolver type for archived values. #51 Fixed a performance regression. #45 Updated and greatly improved the book's documentation. #59 Introduced the ptr_meta crate and vastly reduced the number of dangerous transmutations. #56 Added archive implementations for usize and isize. #55 Made the support for 32/64-bit much more uniform and consistent.

Thanks to everyone who contributed by asking questions, filing issues, and making feature requests.

This bugfix corrects atomic implementations for embedded systems and untangles some dev dependencies that made it difficult to publish crates.

Bugs fixed:

• #58 Atomic support is now enabled and disabled properly for embedded systems.

v0.3.0 changes a few major APIs, adds new features, simplifies the framework, and adds lots of documentation:

• #9 #19 Replace the current archived HashMap implementation with a minimal perfect hashmap implementation. This greatly reduces memory use, but also fixes compatibility issues with the previous implementation. Archive time for hashmaps will likely increase as a result.
• #22 Adds the Unarchive trait with counterparts for unsized types and trait objects. Unarchive is a direct replacement for deserialization and converts archived types back into their unarchived forms.
• #24 Removes WriteExt and SeekExt and folds their functionality into Write and Seek respectively.
• #23 Improves validation performance by a modest amount in most cases.
• #27 Makes it an error to use both #[archive(copy)] and #[archive(name = "...")] or #[archive(derive(...))].
• #25, #30 Adds a book with more narrative documentation on rkyv architecture and features.
• #28 Adds more extensive tests and benchmarks.
• #29 Renames ArchiveSelf to ArchiveCopy and SelfResolver to CopyResolver. The derive argument is now #[archive(copy)].

v0.2.1 adds some small new features and fixes a handful of bugs:

• #14 Empty slices no longer align the writer, which avoids wasting space in some cases.
• #17 With the strict feature, all archived types will be #[repr(C)]. This is probably unnecessary except for the extra cautious.
• #18 A loophole in trait object validation has been patched which could have allowed malicious code execution.
• #21 The Seek trait has been added, along with the archive_root helper. This allows archiving the root object at position 0 in the archive, which is useful for self-describing formats like files and messages.
• #20 Ranges, atomics, and nonzero integer types are now supported by rkyv.

This is a major feature release, adding a wide variety of new features and plugging some existing holes:

#7 Relative pointers now have 64-bit support through the long_rel_ptrs feature. #8 Mutable archives can now be created and mutated through pinned references. #11, #16 bytecheck support has been added, allowing for archive validation. Bytecheck is built with the explicit goal of validating untrusted and potentially malicious data. #12 The core and std archived types are now exposed and documented. #13 Duplicate impls now provide a much more friendly error message to help you track down the problem. #15 Recursive data structures can now be archived properly with use of the #[recursive] attribute on recursive fields.

The next release will be v0.2.1 with any bugfixes and non-breaking changes.

This is a bugfix release to address issues discovered after the previous release and minor feature shortcomings:

#2 Crates with no_std support need #![no_std] #3 Examples allow buffer mutation after archiving #4 Archived fields don't match the visibility of their unarchived counterparts #5 Doesn't compile on rustc < 1.47

Actions have also been set up for the repo to automatically build and run tests.