Feature flags of rkyv crate // Lib.rs

Cargo Features

[dependencies]
rkyv = { version = "0.8.0-alpha.2", default-features = false, features = ["std", "alloc", "little_endian", "pointer_width_16", "pointer_width_32", "pointer_width_64", "copy", "copy_unsafe", "bytecheck", "extra_traits", "indexmap", "triomphe", "uuid", "bitvec", "smallvec", "smol_str", "arrayvec", "tinyvec", "bytes", "thin-vec"] }

default = bytecheck, little_endian, pointer_width_32, std

These default features are set whenever rkyv is added without default-features = false somewhere in the dependency tree.

std default = alloc

Enables std of optional bytecheck, optional bytes, optional indexmap, ptr_meta, and optional uuid

Affects rkyv::ffi…

alloc bytecheck indexmap? std triomphe? = hashbrown

Enables alloc of optional bitvec and optional tinyvec

bitvec:
Support for various common crates. These are primarily to get users off the ground and build some momentum.

These are NOT PLANNED to remain in rkyv for the 1.0 release. Much like serde, these implementations should be moved into their respective crates over time. Before adding support for another crate, please consider getting rkyv support in the crate instead.

Affects ser::AllocSerializer, util::to_bytes, util::from_bytes_unchecked…

little_endian default

big_endian unaligned pointer_width_16

pointer_width_32 default

pointer_width_64

copy

Enables copy of rkyv_derive

Affects rkyv::copy…

copy_unsafe

Affects copy::ArchiveCopyOptimize…

bytecheck default = alloc

Enables bytecheck, bytecheck of rend

Affects rkyv::validation…

extra_traits

indexmap = alloc

External crate support

Enables indexmap

triomphe = alloc

Enables triomphe

uuid

Enables uuid, uuid of optional bytecheck

Features from optional dependencies

In crates that don't use the dep: syntax, optional dependencies automatically become Cargo features. These features may have been created by mistake, and this functionality may be removed in the future.

hashbrown alloc?

bitvec implicit feature

Affects rkyv::bitvec…

smallvec implicit feature