Cargo Features

[dependencies]
oxicode = { version = "0.1.1", default-features = false, features = ["std", "alloc", "derive", "serde", "simd", "compression-lz4", "compression-zstd", "compression", "async-tokio", "async-io"] }
default = derive, std

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

std default = alloc

Enables std of optional serde

serde:

Provide impls for common standard library types like Vec<T> and HashMap<K, V>.
Requires a dependency on the Rust standard library.

Affects read::IoReader, read::StdReader, write::IoWriter, write::StdWriter, serde::encode_into_std_write, serde::decode_from_std_read, oxicode::encode_into_std_write, oxicode::decode_from_std_read, decoder::StreamingDecoder, encoder::StreamingEncoder

alloc serde? std

Enables optional serde

serde:

Provide impls for types in the Rust core allocation and collections library including String, Box<T>, Vec<T>, and Cow<T>. This is a subset of std but may be enabled without depending on all of std.

Affects lz4::compress, lz4::decompress, compression::compress, compression::compress_with_stats, compression::decompress, compression::decompress_or_passthrough, zstd_impl::compress, zstd_impl::decompress, zstd_impl::compress_default, write::VecWriter, encode::VecWriter, serde::encode_to_vec, oxicode::streaming, oxicode::encode_to_vec, oxicode::encode_to_vec_with_config, aligned::AlignedVec, array::encode_f32_array, array::decode_f32_array, array::encode_f64_array, array::decode_f64_array

derive default = oxicode_derive
serde = alloc

Serde integration (optional)

Enables serde

Affects features::serde

simd

SIMD-optimized array encoding (auto-detects CPU capabilities)

Affects oxicode::simd

compression-lz4 compression? = lz4_flex

LZ4 compression (fast, default)

Affects oxicode::compression

compression-zstd = zstd

Zstd compression (better ratio)

Affects oxicode::compression

compression = compression-lz4

Default compression feature

async-tokio = tokio

Async streaming with tokio

Affects async_io::AsyncStreamingEncoder, async_io::AsyncStreamingDecoder, async_io::CancellableAsyncEncoder, async_io::CancellableAsyncDecoder

async-io = futures-io

Generic async IO traits

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.

oxicode_derive derive
lz4_flex compression-lz4?
zstd compression-zstd?
tokio async-tokio?
futures-io async-io?