Struct StateEnvelope 

pub struct StateEnvelope<'a> {
    pub format: FormatId,
    pub payload: &'a [u8],
}

Host-side wrapper around a plugin state payload.

Fields

format: FormatId

Source format of the payload.

payload: &'a [u8]

Opaque plugin bytes.

Implementations

impl StateEnvelope<'_>

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

Serialize this envelope into a freshly-allocated Vec. Hosts then persist the result however they like (disk file, DAW project blob, etc.).

Layout:

0..4   "RKST" magic
4..6   u16 envelope version (little-endian)
6      u8  format id
7      u8  reserved (must be 0)
8..12  u32 payload length (little-endian)
12..   payload bytes

pub fn decode(bytes: &[u8]) -> Result<StateEnvelope<'_>, StateLoadError>

Parse an envelope from bytes. Validates magic, version, and payload length. The returned payload borrows from bytes.

Errors

Returns StateLoadError if the buffer is shorter than the envelope header, the magic bytes do not match, the version is newer than ENVELOPE_VERSION, the format byte is not one of the known FormatId values, or the declared payload length doesn’t match the remaining bytes.

Trait Implementations

impl<'a> Clone for StateEnvelope<'a>

fn clone(&self) -> StateEnvelope<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for StateEnvelope<'a>

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

Formats the value using the given formatter.