Struct VersionedValue 

pub struct VersionedValue {
    pub schema: String,
    pub version: u64,
    pub encoding: Encoding,
    pub payload: Vec<u8>,
}

Deterministic schema/version envelope for an application value.

The envelope is useful when a tree contains values that may evolve over time. It keeps the core map byte-oriented while giving applications a stable place to record a schema name, schema version, value encoding, and payload bytes.

Fields

schema: String

Application schema or type name.

version: u64

Application-controlled schema version.

encoding: Encoding

Encoding used for payload.

payload: Vec<u8>

Encoded application payload.

Implementations

impl VersionedValue

pub fn raw( schema: impl Into<String>, version: u64, payload: impl Into<Vec<u8>>, ) -> Self

Create a versioned raw-byte value.

pub fn json<T: Serialize>( schema: impl Into<String>, version: u64, value: &T, ) -> Result<Self, Error>

Create a versioned JSON value.

pub fn cbor<T: Serialize>( schema: impl Into<String>, version: u64, value: &T, ) -> Result<Self, Error>

Create a versioned CBOR value.

pub fn with_encoding( schema: impl Into<String>, version: u64, encoding: Encoding, payload: impl Into<Vec<u8>>, ) -> Self

Create a versioned value with an explicit encoding marker.

pub fn to_bytes(&self) -> Result<Vec<u8>, Error>

Encode the envelope as deterministic bytes suitable for a leaf value.

pub fn from_bytes(bytes: &[u8]) -> Result<Self, Error>

Decode a deterministic versioned value envelope.

pub fn decode_json<T: DeserializeOwned>(&self) -> Result<T, Error>

Decode the payload as JSON, failing if the envelope is not JSON encoded.

pub fn decode_cbor<T: DeserializeOwned>(&self) -> Result<T, Error>

Decode the payload as CBOR, failing if the envelope is not CBOR encoded.

pub fn require_schema(&self, schema: &str, version: u64) -> Result<(), Error>

Verify the envelope schema and version before decoding a payload.

pub fn matches_schema(&self, schema: &str, version: u64) -> bool

Return true when this value has the requested schema and version.

Trait Implementations

impl Clone for VersionedValue

fn clone(&self) -> VersionedValue

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for VersionedValue

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for VersionedValue

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for VersionedValue

impl PartialEq for VersionedValue

fn eq(&self, other: &VersionedValue) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for VersionedValue

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for VersionedValue