Struct Type1Blob

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§

impl Type1Blob

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. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for Type1Blob

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

Formats the value using the given formatter. Read more

impl Copy for Type1Blob

Auto Trait Implementations§

impl Freeze for Type1Blob

impl RefUnwindSafe for Type1Blob

impl Send for Type1Blob

impl Sync for Type1Blob

impl Unpin for Type1Blob

impl UnwindSafe for Type1Blob

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dst. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> Pointable for T

const ALIGN: usize = _

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.