Struct Volume

pub struct Volume<'data> {
    pub header: VolumeHeader<'data>,
    pub data: &'data [u8],
}

Available on crate feature v1 only.

Filesystem volume, containing the uncompressed files in an ordered directory structure

Fields

header: VolumeHeader<'data>

Header, storing all the offsets and file names in order

data: &'data [u8]

Volume filesystem

Implementations

impl<'a> Volume<'a>

pub fn serialize_atoms(files: BTreeMap<DirOrFile, Vec<u8>>) -> Vec<u8>

Serialize an atom volume.

This is essentially Volume::serialize_files(), but it will modify the input files to uphold several atom-specific invariants - namely that each atom is addressable by its module name. This means:

• All atoms are hoisted to the top level folder
• Extensions are removed from filenames

pub fn serialize_files(files: BTreeMap<DirOrFile, Vec<u8>>) -> Vec<u8>

Create a volume from a set of initial files

pub fn get_all_file_and_dir_entries( &'a self, ) -> Result<BTreeMap<DirOrFile, FsEntry<'a>>, Error>

Returns all files and directories with the corresponding FsEntry

pub fn get_all_file_entries_recursivesorted(&'a self) -> RecursiveFsEntryDir<'a>

Returns all entries in a “tree” sorted structure, i.e. sorted in the same way you’d see the files in a tree explorer

pub fn get_all_file_entries_directorysorted( &'a self, ) -> Vec<(DirOrFile, FsEntry<'a>)>

Returns all entries in a “tree” sorted structure, i.e. sorted in the same way you’d see the files in a tree explorer

pub fn walk<'b>(&'b self) -> VolumeIterator<'a, 'b>

Generic walk function that walks recursively over the files and calls a callback function with self.data on every entry.

pub fn get_all_files_and_directories_with_bytes( &self, ) -> Result<BTreeSet<DirOrFileWithBytes<'_>>, Error>

Returns all the files in this volume, indexed by the full path (in unix fashion, i.e. “/”, “/a”, “/b/file.txt”)

pub fn count_files(&self) -> u64

Returns the number of files in this volume

pub fn count_directories(&self) -> u64

Returns the number of directories in this volume

pub fn list_directories(&self) -> Vec<String>

pub fn parse(data: &'a [u8]) -> Result<Self, Error>

Parses a filesystem volume from a buffer of bytes

pub fn read_dir(&self, path: &str) -> Result<Vec<FsEntry<'a>>, Error>

Returns file entries for $path

pub fn get_file_entry(&self, path: &str) -> Result<OwnedFsEntryFile, Error>

Returns the file entry for $path. Note that this does not return the file contents directly, use volume.get_file(path) instead.

Errors

Returns an error if the file is a directory.

pub fn get_file_bytes( &self, entry: &OwnedFsEntryFile, ) -> Result<&'a [u8], Error>

Given an already-existing OwnedFsEntryFile, returns the byte slice for this file entry.

Errors

The function returns an error if the file entry is out of bounds of the underlying data slice (should never happen)

pub fn get_file(&'a self, path: &str) -> Result<&'a [u8], Error>

Returns the file contents (shorthand for volume.get_file_bytes(volume.get_file_entry(path)))

pub fn into_bytes(&self) -> Vec<u8>

Serializes the volume into writable bytes (including the header and header length)

Trait Implementations

impl<'data> Clone for Volume<'data>

fn clone(&self) -> Volume<'data>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'data> Debug for Volume<'data>

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

Formats the value using the given formatter.

impl<'data> Default for Volume<'data>

fn default() -> Volume<'data>

Returns the “default value” for a type.

impl<'data> PartialEq for Volume<'data>

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

impl<'data> StructuralPartialEq for Volume<'data>