Struct VirtualFileEncoder 

pub struct VirtualFileEncoder {
    pub file_header: FileHeader,
    pub file_footer: VirtualFileFooter,
    pub vfm: Option<VirtualFileMap>,
    /* private fields */
}

Encodes the a virtual file.

Fields

file_header: FileHeader

The appropriate FileHeader.

file_footer: VirtualFileFooter

The appropriate VirtualFileFooter.

vfm: Option<VirtualFileMap>

The resolved virtual file map for regular virtual files, in case of a virtual regular file.

Implementations

impl VirtualFileEncoder

pub fn new( file_header: FileHeader, file_footer: VirtualFileFooter, vfm: Option<VirtualFileMap>, encryption_information: Option<EncryptionInformation>, ) -> Self

Creates a new VirtualFileEncoder from the header, footer, optional virtual file map, and optional encryption information.

pub fn file_header_ref(&self) -> &FileHeader

Returns a reference of the appropriate file header

pub fn encoded_header(&self) -> Result<Vec<u8>>

Returns the encoded FileHeader.

Error

Returns an error if the file header is encrypted and the encryption fails.

pub fn encoded_vfm(&self) -> Result<Option<Vec<u8>>>

Returns the encoded VirtualFileMap, if this virtual file has one.

Error

Returns an error if encoding the virtual file map with the configured encryption settings fails.

pub fn encoded_footer(&self) -> Result<Vec<u8>>

Returns the appropriate encoded VirtualFileFooter.

Error

Returns an error if the file footer is encrypted and the encryption fails.

Trait Implementations

impl Drop for VirtualFileEncoder

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.