Struct PackageEntry

pub struct PackageEntry { /* private fields */ }

Represents a file entry in a Package.

These entries consist basically only of the file’s path within the package (here called an inner_path), and a reference to the file’s content.

Implementations

impl PackageEntry

pub fn from_file<S: AsRef<str>, P: AsRef<Path>>( inner_path: S, path: P, ) -> PackageEntry

Constructs an PackageEntry from the given inner_path and file at the specified path.

• inner_path - path under which the file will be stored within the Package.
• path - path to the file that will be read to populate this entry’s content.

pub fn from_memory_mapped_file<S: AsRef<str>>( inner_path: S, mmap: Rc<Mmap>, offset: u64, length: u64, ) -> PackageEntry

Constructs an PackageEntry from the given inner_path, memory map, offset and length

• inner_path - path under which the file will be stored within the Package.
• mmap - memory map of the file from which the file’s content will be read.
• offset - offset to the file’s content within the memory mapped file.
• length - length of the file’s content within the memory mapped file.

pub fn from_string<S: AsRef<str>, C: AsRef<str> + Into<Vec<u8>>>( inner_path: S, content: C, ) -> PackageEntry

Constructs an PackageEntry from the given inner_path and text content.

• inner_path - path under which the file will be stored within the Package.
• content - textual content of the file.

pub fn from_byte_array<S: AsRef<str>>( inner_path: S, content: Vec<u8>, ) -> PackageEntry

Constructs an PackageEntry from the given inner_path and binary content.

• inner_path - path under which the file will be stored within the Package.
• content - binary content of the file.

pub fn inner_path(&self) -> &str

Returns the inner_path of this entry.

pub fn content(&self) -> Result<Vec<u8>, Error>

Returns a view of this entry’s content as bytes.

Trait Implementations

impl Debug for PackageEntry

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

Formats the value using the given formatter.

impl Display for PackageEntry

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

Formats the value using the given formatter.