Struct FileHeader 

pub struct FileHeader { /* private fields */ }

Each dumped file* contains a FileHeader containing several metadata. The following metadata are included in a FileHeader:

• the internal file number of the appropriate file.
• the FileType of the appropriate file.
• the original filename of the appropriate file without the full path (just the filename, e.g. “my_texfile.txt” or “my_directory”)
• the file number of the parent directory of this file (if the file lies into the root directory, this is 0 because the first valid file number in zff is 1).
• the atime, mtime, ctime and btime.
• A HashMap to extend the metadata based on the operating system/filesystem. Some fields are predefined, see the full list in the wiki

Implementations

impl FileHeader

pub fn new<F: Into<String>>( version: u8, file_number: u64, file_type: FileType, filename: F, parent_file_number: u64, atime: u64, mtime: u64, ctime: u64, btime: u64, metadata_ext: HashMap<String, String>, ) -> FileHeader

creates a new FileHeader with the given values.

pub fn file_number(&self) -> u64

returns the file number

pub fn file_type(&self) -> FileType

returns the FileType

pub fn filename(&self) -> &str

returns the filename

pub fn parent_file_number(&self) -> u64

returns the file number of the parent directory

pub fn atime(&self) -> u64

returns the atime

pub fn mtime(&self) -> u64

returns the mtime

pub fn ctime(&self) -> u64

returns the ctime

pub fn btime(&self) -> u64

returns the btime

pub fn metadata_ext(&self) -> &HashMap<String, String>

returns the extended metadata HashMap as a reference.

pub fn transform_to_hardlink(&mut self)

transforms the inner FileType to a FileType::Hardlink. This does not work with a FileType::Symlink!

pub fn encode_encrypted_header_directly<K>( &self, key: K, encryption_header: EncryptionHeader, ) -> Result<Vec<u8>>

where K: AsRef<[u8]>,

encodes the file header to a Vec<u8>. The encryption flag of the appropriate object header has to be set to 2.

Error

The method returns an error, if the encryption fails.

pub fn decode_encrypted_header_with_key<R, K>( data: &mut R, key: K, encryption_header: EncryptionHeader, ) -> Result<FileHeader>

where R: Read, K: AsRef<[u8]>,

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 FileHeader

fn clone(&self) -> FileHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileHeader

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

Formats the value using the given formatter.

impl HeaderCoding for FileHeader

type Item = FileHeader

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<FileHeader>

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.

impl PartialEq for FileHeader

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

impl StructuralPartialEq for FileHeader