Struct zff::header::version1::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 other headers (e.g. compression header, description header, …) and start information.

Implementations

impl MainHeader

pub fn new(
    version: u8,
    encryption_header: Option<EncryptionHeader>,
    compression_header: CompressionHeader,
    description_header: DescriptionHeader,
    hash_header: HashHeader,
    chunk_size: u8,
    signature_flag: u8,
    segment_size: u64,
    number_of_segments: u64,
    unique_identifier: i64,
    length_of_data: u64
) -> MainHeader

returns a new main header with the given values.

pub fn encrypted_header_identifier() -> u32

returns the header identifier for the encrypted main header.

pub fn decode_encrypted_header_with_password<R, P>(
    data: &mut R,
    password: P
) -> Result<MainHeader> where
    R: Read,
    P: AsRef<[u8]>, 

decodes the encrypted main header with the given password.

pub fn encode_encrypted_header_directly<K>(&self, key: K) -> Result<Vec<u8>> where
    K: AsRef<[u8]>, 

encodes the main header to a Vec<u8>. The encryption flag will be set to 2.

Error

The method returns an error, if the encryption header is missing (=None).

pub fn set_length_of_data(&mut self, len: u64)

sets the length of the dumped data.

pub fn set_hash_header(&mut self, hash_header: HashHeader)

sets the hash header.

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 get_encrypted_encoded_size<K>(&self, key: K) -> Result<usize> where
    K: AsRef<[u8]>, 

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

Error

The method fails, if the encryption fails or no encryption header is present.

pub fn has_signature(&self) -> bool

returns, if the chunks has a ed25519 signature or not.

pub fn set_acquisition_end(&mut self, timestamp: u64)

sets the acquisition end timestamp of the inner description header.

pub fn compression_header(&self) -> &CompressionHeader

returns a reference to the inner compression header

pub fn encryption_header(&self) -> &Option<EncryptionHeader>

returns a reference to the inner encryption header (if available)

pub fn description_header(&self) -> &DescriptionHeader

returns a reference to the inner description header

pub fn hash_header(&self) -> &HashHeader

returns a reference to the inner hash header

pub fn length_of_data(&self) -> u64

returns the length of the content data

pub fn unique_identifier(&self) -> i64

returns the unique identifier

pub fn set_number_of_segments(&mut self, value: u64)

sets the number of segments

pub fn number_of_segments(&self) -> u64

returns the number of segments

Trait Implementations

impl Clone for MainHeader

fn clone(&self) -> MainHeader

Returns a copy 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.