Struct HummockVersionCheckpointEnvelope 

pub struct HummockVersionCheckpointEnvelope {
    pub compression_algorithm: i32,
    pub payload: Vec<u8>,
    pub checksum: Option<u64>,
}

Envelope message wrapping a compressed or uncompressed HummockVersionCheckpoint. When compression_algorithm is NONE (or UNSPECIFIED), payload contains raw PbHummockVersionCheckpoint bytes. Otherwise, payload contains the compressed PbHummockVersionCheckpoint bytes.

Backward compatibility:

• Old code (unaware of this message) writes raw PbHummockVersionCheckpoint directly.
• New code tries to decode as HummockVersionCheckpointEnvelope first. If it fails (old format), it falls back to decoding as PbHummockVersionCheckpoint.
• Legacy bytes may occasionally decode as an envelope due to protobuf’s unknown-field skipping, so readers treat checksum as the discriminator: all new envelopes set it, while old raw checkpoints do not have field 3.

Format detection logic:

1. Try to decode bytes as HummockVersionCheckpointEnvelope
2. If checksum.is_some(), treat as new envelope format: a. Verify checksum against payload b. Decompress payload according to compression_algorithm c. Decode decompressed bytes as PbHummockVersionCheckpoint
3. If checksum.is_none() or decode fails, treat as legacy format:
   • Decode bytes directly as PbHummockVersionCheckpoint

Fields

compression_algorithm: i32

payload: Vec<u8>

Compressed (or uncompressed if algorithm is NONE) PbHummockVersionCheckpoint bytes.

checksum: Option<u64>

xxhash64 checksum of the payload bytes (compressed data) for integrity verification. Presence of this field distinguishes new envelope format from legacy raw checkpoints.

Implementations

impl HummockVersionCheckpointEnvelope

pub fn compression_algorithm(&self) -> CheckpointCompressionAlgorithm

Returns the enum value of compression_algorithm, or the default if the field is set to an invalid enum value.

pub fn set_compression_algorithm( &mut self, value: CheckpointCompressionAlgorithm, )

Sets compression_algorithm to the provided enum value.

pub fn checksum(&self) -> u64

Returns the value of checksum, or the default value if checksum is unset.

impl HummockVersionCheckpointEnvelope

pub fn get_compression_algorithm( &self, ) -> Result<CheckpointCompressionAlgorithm, PbFieldNotFound>

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

pub fn get_checksum(&self) -> Result<&u64, PbFieldNotFound>

Trait Implementations

impl Clone for HummockVersionCheckpointEnvelope

fn clone(&self) -> HummockVersionCheckpointEnvelope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HummockVersionCheckpointEnvelope

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

Formats the value using the given formatter.

impl Default for HummockVersionCheckpointEnvelope

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for HummockVersionCheckpointEnvelope

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for HummockVersionCheckpointEnvelope

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for HummockVersionCheckpointEnvelope

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for HummockVersionCheckpointEnvelope

fn eq(&self, other: &HummockVersionCheckpointEnvelope) -> 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 Serialize for HummockVersionCheckpointEnvelope

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for HummockVersionCheckpointEnvelope

impl StructuralPartialEq for HummockVersionCheckpointEnvelope