Skip to main content

encode_versioned_value

Function encode_versioned_value 

Source
pub fn encode_versioned_value<E: Encode>(
    value: &E,
    version: Version,
) -> Result<Vec<u8>>
Available on crate feature alloc only.
Expand description

Encode a value with a version header for forward-compatible storage.

The output contains an OXIV version header followed by the oxicode-encoded value. Use decode_versioned_value to recover the value and version.

ยงExamples

use oxicode::versioning::Version;
let version = Version::new(1, 0, 0);
let encoded = oxicode::encode_versioned_value(&42u32, version).expect("encode failed");
let (decoded, ver, _consumed): (u32, _, _) =
    oxicode::decode_versioned_value(&encoded).expect("decode failed");
assert_eq!(decoded, 42u32);
assert_eq!(ver, version);