Struct MainHeader 

pub struct MainHeader { /* private fields */ }

The main header is the first Header, which can be found at the beginning of the first segment.
This header contains a lot of metadata about the zff container

• the target chunk size: the size of the chunks in which the original data was read.
• the target segment size
• a unique identifier, written to each segment header: With this identifier you can uniquely assign the corresponding segments that belong together: there may be cases where you don’t want to or can’t do this via the file names.

Implementations

impl MainHeader

pub fn new( version: u8, chunk_size: u8, segment_size: u64, unique_identifier: i64, ) -> MainHeader

returns a new main header with the given values.

pub fn chunk_size(&self) -> usize

returns the chunk_size.

pub fn segment_size(&self) -> u64

returns the segment size

pub fn get_encoded_size(&self) -> usize

returns the len() of the Vec<u8> (encoded main header).

pub fn unique_identifier(&self) -> i64

returns the unique identifier

Trait Implementations

impl Clone for MainHeader

fn clone(&self) -> MainHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MainHeader

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

Formats the value using the given formatter.

impl HeaderCoding for MainHeader

type Item = MainHeader

the return value for decode_content(), decode_directly(), decode_for_key();

fn identifier() -> u32

returns the identifier (=Magic bytes) of the header.

fn version(&self) -> u8

returns the version of the header.

fn encode_header(&self) -> Vec<u8>

encodes the header.

fn decode_content(data: Vec<u8>) -> Result<MainHeader>

decodes the content of the header.

fn header_size(&self) -> usize

returns the size of the encoded header (in bytes)

fn encode_key<K: Into<String>>(key: K) -> Vec<u8>

encodes a given key.

fn encode_directly(&self) -> Vec<u8>

encodes the (header) value/object directly (= without key).

fn encode_for_key<K: Into<String>>(&self, key: K) -> Vec<u8>

encodes a key to the (header) value/object.

fn decode_header_length<R: Read>(data: &mut R) -> Result<u64>

decodes the length of the header.

fn check_identifier<R: Read>(data: &mut R) -> bool

checks if the read identifier is valid for this header.

fn check_key_on_position<K: Into<String>, R: Read>(data: &mut R, key: K) -> bool

helper method to check, if the key is on position.

fn decode_directly<R: Read>(data: &mut R) -> Result<Self::Item>

decodes the header directly.

fn decode_for_key<K: Into<String>, R: Read>( data: &mut R, key: K, ) -> Result<Self::Item>

decodes the header for the given key.