Struct Header 

pub struct Header {

    pub magic: [u8; 4],
    pub version: u32,
    pub block_size: u32,
    pub index_offset: u64,
    pub parent_paths: Vec<String>,
    pub dictionary_offset: Option<u64>,
    pub dictionary_length: Option<u32>,
    pub metadata_offset: Option<u64>,
    pub metadata_length: Option<u32>,
    pub signature_offset: Option<u64>,
    pub signature_length: Option<u32>,
    pub encryption: Option<KeyDerivationParams>,
    pub compression: CompressionType,
    pub features: FeatureFlags,
    pub cdc_params: Option<(u32, u32, u32)>,
}

On-disk archive file header containing format metadata.

Fields

magic: [u8; 4]

Magic bytes identifying the file as a Hexz archive.

version: u32

Format version number for compatibility checks.

block_size: u32

Block size in bytes used for data segmentation.

index_offset: u64

Byte offset of the master index within the archive.

parent_paths: Vec<String>

Paths to parent archives for thin (incremental) archives.

dictionary_offset: Option<u64>

Byte offset of the compression dictionary, if present.

dictionary_length: Option<u32>

Length in bytes of the compression dictionary, if present.

metadata_offset: Option<u64>

Byte offset of the metadata section, if present.

metadata_length: Option<u32>

Length in bytes of the metadata section, if present.

signature_offset: Option<u64>

Byte offset of the digital signature, if present.

signature_length: Option<u32>

Length in bytes of the digital signature, if present.

encryption: Option<KeyDerivationParams>

Key derivation parameters when the archive is encrypted.

compression: CompressionType

Compression algorithm used for data blocks.

features: FeatureFlags

Feature flags indicating enabled capabilities.

cdc_params: Option<(u32, u32, u32)>

Content-defined chunking parameters used for this archive. (fingerprint_bits, min_chunk, max_chunk)

Implementations

impl Header

pub fn read_from<R: Read>(reader: &mut R) -> Result<Self>

Read and deserialize a header from a std::io::Read source.

pub fn read_from_backend(backend: &dyn StorageBackend) -> Result<Self>

Read a header from a StorageBackend at offset 0.

pub fn load_dictionary( &self, backend: &dyn StorageBackend, ) -> Result<Option<Vec<u8>>>

Load the compression dictionary from the backend, if present.

Trait Implementations

impl Clone for Header

fn clone(&self) -> Header

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Header

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

Formats the value using the given formatter.

impl Default for Header

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Header

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Header

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

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 Header

impl StructuralPartialEq for Header