Struct delivery_blob::Type1Blob

pub struct Type1Blob {
    pub header: DeliveryBlobHeader,
    pub payload_length: usize,
    pub is_compressed: bool,
}

Header + metadata fields of a Type 1 blob.

WARNING: Outside of storage-owned components, this should only be used for informational or debugging purposes. The contents of this struct should be considered internal implementation details and are subject to change at any time.

Fields

header: DeliveryBlobHeader

payload_length: usize

is_compressed: bool

Implementations

impl Type1Blob

pub const HEADER: DeliveryBlobHeader = _

pub fn generate(data: &[u8], mode: CompressionMode) -> Vec<u8>

Generate a Type 1 delivery blob for data using the specified mode.

WARNING: This function will panic on error.

pub fn generate_to( data: &[u8], mode: CompressionMode, writer: impl Write ) -> Result<(), Error>

Generate a Type 1 delivery blob for data using the specified mode. Writes delivery blob directly into writer.

WARNING: This function will panic on compression errors.

pub fn parse( data: &[u8] ) -> Result<Option<(Type1Blob, &[u8])>, DeliveryBlobError>

Attempt to parse data as a Type 1 delivery blob. On success, returns validated blob info, and the remainder of data representing the blob payload. WARNING: This function does not verify that the payload is complete. Only the full header and metadata portion of a delivery blob are required to be present in data.

pub fn decompressed_size(delivery_blob: &[u8]) -> Result<u64, DecompressError>

Return the decompressed size of the blob without decompressing it.

pub fn decompress(delivery_blob: &[u8]) -> Result<Vec<u8>, DecompressError>

Decompress a Type 1 delivery blob in delivery_blob.

pub fn decompress_to( delivery_blob: &[u8], writer: impl Write ) -> Result<(), DecompressError>

Decompress a Type 1 delivery blob in delivery_blob to writer.

Trait Implementations

impl Clone for Type1Blob

fn clone(&self) -> Type1Blob

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Type1Blob

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

Formats the value using the given formatter.

impl Copy for Type1Blob