Struct VersionedEnvelope 

pub struct VersionedEnvelope {
    pub version: u8,
    pub crdt_type: CrdtType,
    pub payload: Vec<u8>,
}

A version envelope wrapping serialized CRDT data.

Binary format (3 bytes overhead):

[MAGIC: 0xCF][VERSION: u8][CRDT_TYPE: u8][PAYLOAD: N bytes]

Example

use crdt_migrate::{VersionedEnvelope, CrdtType};

let data = b"some serialized crdt state";
let envelope = VersionedEnvelope::new(1, CrdtType::GCounter, data.to_vec());

let bytes = envelope.to_bytes();
let decoded = VersionedEnvelope::from_bytes(&bytes).unwrap();

assert_eq!(decoded.version, 1);
assert_eq!(decoded.crdt_type, CrdtType::GCounter);
assert_eq!(decoded.payload, data);

Fields

version: u8

Schema version of the payload.

crdt_type: CrdtType

Type of CRDT contained.

payload: Vec<u8>

Serialized CRDT data.

Implementations

impl VersionedEnvelope

pub fn new(version: u8, crdt_type: CrdtType, payload: Vec<u8>) -> Self

Create a new envelope.

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

Serialize the envelope to bytes.

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

Parse an envelope from bytes.

pub fn peek_version(data: &[u8]) -> Result<u8, EnvelopeError>

Peek at the version without fully parsing the envelope.

pub fn is_versioned(data: &[u8]) -> bool

Check if bytes look like a versioned envelope (starts with magic byte).

Trait Implementations

impl Clone for VersionedEnvelope

fn clone(&self) -> VersionedEnvelope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VersionedEnvelope

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

Formats the value using the given formatter.

impl PartialEq for VersionedEnvelope

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for VersionedEnvelope