Struct VirtualFileFooter 

pub struct VirtualFileFooter {
    pub filenumber: u64,
    pub hash_header: HashHeader,
    pub length_of_data: u64,
    pub vffc: VirtualFileFooterContent,
}

Footer of a virtual logical file.

This footer stores the virtual file’s file number, hash metadata, logical data length, and the type-specific VirtualFileFooterContent.

Fields

filenumber: u64

The file number of the virtual file this footer belongs to.

hash_header: HashHeader

The hash information for the virtual file data.

length_of_data: u64

The logical length of the represented file data in bytes.

vffc: VirtualFileFooterContent

The type-specific virtual file footer content.

Implementations

impl VirtualFileFooter

pub fn new( filenumber: u64, hash_header: HashHeader, length_of_data: u64, vffc: VirtualFileFooterContent, ) -> Self

Creates a new VirtualFileFooter from the file number, hash information, logical data length, and footer content.

pub fn decode_at_encrypted_footer_with_key<R, E>( data: &R, offset: u64, encryption_information: E, ) -> Result<Self>

where R: ReadAt + ?Sized, E: Borrow<EncryptionInformation>,

decodes the encrypted header with the given key and crate::header::EncryptionHeader at given offset. The appropriate crate::header::EncryptionHeader has to be stored in the appropriate crate::header::ObjectHeader.

pub fn decode_encrypted_footer_with_key<R, E>( data: &mut R, encryption_information: E, ) -> Result<Self>

where R: Read, E: Borrow<EncryptionInformation>,

decodes the encrypted header with the given key and crate::header::EncryptionHeader. The appropriate crate::header::EncryptionHeader has to be stored in the appropriate crate::header::ObjectHeader.

Trait Implementations

impl Clone for VirtualFileFooter

fn clone(&self) -> VirtualFileFooter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VirtualFileFooter

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

Formats the value using the given formatter.

impl Encryption for VirtualFileFooter

fn crypto_nonce_padding() -> u8

The appropriate, type specific padding value for the nonce (see official zff documentation).

fn encrypt<K, M, A>( key: K, message: M, nonce_value: u64, algorithm: A, ) -> Result<Vec<u8>>

where K: AsRef<[u8]>, M: AsRef<[u8]>, A: Borrow<EncryptionAlgorithm>,

Encrypts the message, using the type specific nonce padding.

fn decrypt<K, M, A>( key: K, message: M, nonce_value: u64, algorithm: A, ) -> Result<Vec<u8>>

where K: AsRef<[u8]>, M: AsRef<[u8]>, A: Borrow<EncryptionAlgorithm>,

Decrypts the message, using the type specific nonce padding.

fn gen_crypto_nonce(nonce_value: u64) -> Result<Nonce<U12>>

Method to generate a 96-bit nonce for the appropriate message type (using the given value).

impl Eq for VirtualFileFooter

impl From<VirtualFileFooter> for VirtualFileFooterMetadata

fn from(vff: VirtualFileFooter) -> Self

Converts to this type from the input type.

impl HeaderCoding for VirtualFileFooter

type Item = VirtualFileFooter

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

fn version() -> u8

returns the version of the header. This reflects the default version of the appropriate header used in zff v3.

fn identifier() -> u32

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

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

encodes the (potentially encryptable) content of the struct.

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

encodes the (non-encryptable) content of the struct.

fn decode_content(data: &[u8]) -> Result<Self>

decodes the content of the header.

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

encodes 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 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_version<R: Read>(data: &mut R) -> Result<()>

checks if the read header / footer version is supported by this crate (only zff v3 headers / footers are supported).

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

decodes the header directly.

fn decode_at<R: ReadAt + ?Sized>(data: &R, offset: u64) -> Result<Self::Item>

decodes the header at given offset.

fn struct_name() -> &'static str

Method to show the “name” of the appropriate struct (e.g. to use this with fmt::Display). This method is a helper method for fmt::Display and serde::ser::SerializeStruct (and for some debugging purposes).

impl HeaderEncryption for VirtualFileFooter

fn nonce_value(&self) -> u64

The value which should be used to calculate the nonce (e.g. the filenumber for a FileHeader).

fn encryption_precondition(&self) -> bool

Optional precondition to check if encryption is possible. true if encryption is possible, false if precondition fails.

fn encrypt_directly<E: Borrow<EncryptionInformation>>( &self, encryption_information: E, ) -> Result<Vec<u8>>

encodes the header to a Vec<u8>.

fn encode_encrypted_header<E: Borrow<EncryptionInformation>>( &self, encryption_information: E, ) -> Result<Vec<u8>>

encrypts and encodes the header.

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

Sometimes, we have to set flag values…than, we have to modify the fixed fields.

impl PartialEq for VirtualFileFooter

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for VirtualFileFooter