Skip to main content

CommandEnvelope

Struct CommandEnvelope 

Source
pub struct CommandEnvelope {
    pub format_version: u32,
    pub command_id: [u8; 16],
    pub command_type: u32,
    pub payload: Vec<u8>,
    pub payload_sha256: [u8; 32],
}
Expand description

The versioned, checksummed form of every persisted command.

Fields§

§format_version: u32

Envelope format version; see COMMAND_ENVELOPE_FORMAT_VERSION.

§command_id: [u8; 16]

Unique identifier of this command (for idempotent apply).

§command_type: u32

Discriminant of the payload command; numbers are never reused.

§payload: Vec<u8>

Schema-evolution-safe encoded command payload. The envelope never interprets these bytes; unknown optional payload fields are preserved or ignored safely by the payload decoder.

§payload_sha256: [u8; 32]

SHA-256 over version, type, length, and payload.

Implementations§

Source§

impl CommandEnvelope

Source

pub fn new(command_type: u32, command_id: [u8; 16], payload: Vec<u8>) -> Self

Builds an envelope at the current format version, computing the checksum.

Source

pub fn checksum( format_version: u32, command_type: u32, payload: &[u8], ) -> [u8; 32]

Computes the checksum covering type, version, length, and payload.

Source

pub fn verify(&self) -> Result<(), EnvelopeError>

Fails closed unless the version is supported and the checksum matches.

Source

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

Serializes to the canonical deterministic encoding: equal envelopes always produce byte-identical output.

Source

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

Parses one envelope, verifying version and checksum (fails closed).

Trait Implementations§

Source§

impl Clone for CommandEnvelope

Source§

fn clone(&self) -> CommandEnvelope

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CommandEnvelope

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for CommandEnvelope

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for CommandEnvelope

Source§

impl PartialEq for CommandEnvelope

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for CommandEnvelope

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for CommandEnvelope

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.