Struct Bundle 

pub struct Bundle { /* private fields */ }

An open UnityFS bundle: its header, blocks and nodes, with the file kept open to read nodes by range.

Implementations

impl Bundle

pub fn open(path: &Path) -> Result<Self>

Open the bundle at path: read its header and block table and check that the sizes add up (the header’s size is the file’s, the blocks end where the file does, every node lies in the blocks’ bytes). Reads nothing of the data.

pub fn from_source(path: &Path, source: Box<dyn BundleSource>) -> Result<Self>

As Bundle::open, on any seekable source (path only names it in errors).

pub fn path(&self) -> &Path

The file the bundle was opened from.

pub fn header(&self) -> &BundleHeader

The header as stored.

pub fn hash(&self) -> [u8; 16]

The 16 bytes at the start of the block table (nothing reads them).

pub fn nodes(&self) -> &[BundleNode]

The files in the bundle, in the order the directory lists them.

pub fn node(&self, path: &str) -> Option<&BundleNode>

The node whose path is exactly path.

pub fn blocks(&self) -> impl ExactSizeIterator<Item = Block> + '_

The blocks, in data order.

pub fn data_len(&self) -> u64

The size of all blocks once decompressed.

pub fn read( &self, node: &BundleNode, offset: u64, len: usize, ) -> Result<Vec<u8>>

len bytes of node, from offset bytes into it. Only the blocks the range touches are decompressed. A range outside the node is an error.

pub fn read_node(&self, node: &BundleNode) -> Result<Vec<u8>>

All of node’s bytes. Blocks are decompressed one after the other and not kept.

Trait Implementations

impl Debug for Bundle

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

Formats the value using the given formatter.