Struct Type1Blob

Source

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

Expand description

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§

Source §

impl Type1Blob

Source

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.

Source

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.

Source

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.

Source

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

Return the decompressed size of the blob without decompressing it.

Source

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

Decompress a Type 1 delivery blob in delivery_blob.

Source

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§

Source §

impl Clone for Type1Blob

Source §

fn clone(&self) -> Type1Blob

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

impl Debug for Type1Blob

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Copy for Type1Blob

Auto Trait Implementations§

§

impl UnwindSafe for Type1Blob

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> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into 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> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

§