Struct SyncFrame 

#[non_exhaustive]
pub struct SyncFrame {
    pub msg_type: SyncMessageType,
    pub body: Vec<u8>,
}

Wire frame: wraps a message type + serialized body with format versioning and CRC32C integrity protection.

Layout: [version: 1B][msg_type: 1B][length: 4B LE][crc32c: 4B LE][body: N bytes] Total header: 10 bytes.

Mirrors the WAL record header model: every frame carries a format version byte (enabling hard rejection of future incompatible formats) and a CRC32C checksum over the body for silent-corruption detection. There is no checksum-skip sentinel — CRC32C is always computed and always verified.

#[non_exhaustive] — additional header fields (e.g. compression flag, session token) may be added without breaking downstream consumers.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

msg_type: SyncMessageType

body: Vec<u8>

Implementations

impl SyncFrame

pub const FORMAT_VERSION: u8 = 1

Current wire format version embedded in every frame header.

pub const HEADER_SIZE: usize = 10

Total size of the frame header in bytes.

Layout: [version:1][msg_type:1][len:4 LE][crc32c:4 LE] = 10 bytes.

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

Serialize a frame to bytes.

Produces [FORMAT_VERSION][msg_type][body_len as u32 LE][crc32c(body) as u32 LE][body].

pub fn from_bytes(data: &[u8]) -> Option<Self>

Deserialize a frame from bytes.

Returns None if:

• the buffer is shorter than HEADER_SIZE,
• the version byte does not match FORMAT_VERSION (unknown future version),
• the message type discriminant is unrecognised,
• the buffer is too short to contain the declared body length, or
• the CRC32C of the body does not match the header checksum (corrupt frame).

pub fn new_msgpack<T: ToMessagePack>( msg_type: SyncMessageType, value: &T, ) -> Option<Self>

Create a frame with a MessagePack-serialized body.

pub fn try_encode<T: ToMessagePack>( msg_type: SyncMessageType, value: &T, ) -> Option<Self>

Try to encode a value into a SyncFrame body.

Returns None and logs an error on serialization failure — callers should propagate via ?. The protocol must never ship a frame whose body did not serialize successfully.

pub fn decode_body<T: FromMessagePackOwned>(&self) -> Option<T>

Deserialize the body from MessagePack.

Trait Implementations

impl Clone for SyncFrame

fn clone(&self) -> SyncFrame

Returns a duplicate of the value.

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

Performs copy-assignment from source.