Struct ZstandardFrameHeader

Source

pub struct ZstandardFrameHeader {
    pub frame_descriptor: ZstandardFrameDescriptor,
    pub window_descriptor: Option<u8>,
    pub did: Vec<u8>,
    pub frame_content_size: Vec<u8>,
}

Expand description

A Zstandard Frame header.

This doesn’t include the blocks and checksum, so you need to do your own accounting and parse the blocks until the last, then read the checksum if it’s present. See ZstandardFrame for an easier interface, at the cost of loading all the blocks in memory.

Spec

Fields§

§frame_descriptor: ZstandardFrameDescriptor

The frame descriptor.

Spec

Describes what other fields are present in the frame header.

§window_descriptor: Option<u8>

Minimum memory needed to decode the frame.

Spec

§did: Vec<u8>

Dictionary ID.

Spec

See [ZstandardFrame::dictionary_id()] for the value as an integer.

§frame_content_size: Vec<u8>

Original (uncompressed) size.

Spec

This field is optional.

This needs to be interpreted before it can be used. See [ZstandardFrame::size()].

Struct ZstandardFrameHeader Copy item path

Fields§

Implementations§

impl ZstandardFrameHeader

pub fn uncompressed_size(&self) -> u64

pub fn dictionary_id(&self) -> u32

Trait Implementations§

impl Clone for ZstandardFrameHeader

fn clone(&self) -> ZstandardFrameHeader

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

impl Debug for ZstandardFrameHeader

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

impl DekuContainerRead<'_> for ZstandardFrameHeader

fn from_bytes( __deku_input: (&[u8], usize), ) -> Result<((&[u8], usize), Self), DekuError>

impl DekuContainerWrite for ZstandardFrameHeader

fn to_bytes(&self) -> Result<Vec<u8>, DekuError>

fn to_bits(&self) -> Result<BitVec<u8, Msb0>, DekuError>

impl DekuRead<'_> for ZstandardFrameHeader

fn read( __deku_input_bits: &BitSlice<u8, Msb0>, _: (), ) -> Result<(&BitSlice<u8, Msb0>, Self), DekuError>

impl DekuRead<'_, Endian> for ZstandardFrameHeader

fn read( __deku_input_bits: &BitSlice<u8, Msb0>, endian: Endian, ) -> Result<(&BitSlice<u8, Msb0>, Self), DekuError>

impl DekuUpdate for ZstandardFrameHeader

fn update(&mut self) -> Result<(), DekuError>

impl DekuWrite<Endian> for ZstandardFrameHeader

fn write( &self, __deku_output: &mut BitVec<u8, Msb0>, endian: Endian, ) -> Result<(), DekuError>

impl DekuWrite for ZstandardFrameHeader

fn write( &self, __deku_output: &mut BitVec<u8, Msb0>, _: (), ) -> Result<(), DekuError>

impl PartialEq for ZstandardFrameHeader

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

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

impl TryFrom<&[u8]> for ZstandardFrameHeader

type Error = DekuError

fn try_from(input: &[u8]) -> Result<Self, Self::Error>

impl TryFrom<ZstandardFrameHeader> for BitVec<u8, Msb0>

type Error = DekuError

fn try_from(input: ZstandardFrameHeader) -> Result<Self, Self::Error>

impl TryFrom<ZstandardFrameHeader> for Vec<u8>

type Error = DekuError

fn try_from(input: ZstandardFrameHeader) -> Result<Self, Self::Error>

impl Eq for ZstandardFrameHeader

impl StructuralPartialEq for ZstandardFrameHeader

Auto Trait Implementations§

impl Freeze for ZstandardFrameHeader

impl RefUnwindSafe for ZstandardFrameHeader

impl Send for ZstandardFrameHeader

impl Sync for ZstandardFrameHeader

impl Unpin for ZstandardFrameHeader

impl UnwindSafe for ZstandardFrameHeader

Blanket Implementations§

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> CloneToUninit for Twhere T: Clone,

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

impl<T> Conv for T

fn conv<T>(self) -> Twhere Self: Into<T>,

impl<T> FmtForward for T

fn fmt_binary(self) -> FmtBinary<Self>where Self: Binary,

fn fmt_display(self) -> FmtDisplay<Self>where Self: Display,

fn fmt_lower_exp(self) -> FmtLowerExp<Self>where Self: LowerExp,

fn fmt_lower_hex(self) -> FmtLowerHex<Self>where Self: LowerHex,

fn fmt_octal(self) -> FmtOctal<Self>where Self: Octal,

fn fmt_pointer(self) -> FmtPointer<Self>where Self: Pointer,

fn fmt_upper_exp(self) -> FmtUpperExp<Self>where Self: UpperExp,

fn fmt_upper_hex(self) -> FmtUpperHex<Self>where Self: UpperHex,

fn fmt_list(self) -> FmtList<Self>where &'a Self: for<'a> IntoIterator,

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

impl<T> Pipe for Twhere T: ?Sized,

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere Self: Sized,

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere R: 'a,

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere R: 'a,

Struct ZstandardFrameHeader

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

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

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

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

fn conv<T>(self) -> T
where Self: Into<T>,

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

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

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

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

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

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

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

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

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,