Struct Pack 

pub struct Pack<'a> { /* private fields */ }

A pack’s files, read and unpacked: what a game lays in its bundle. A file the pack keeps as it is borrows the pack’s bytes ('a); only a compressed one is unpacked into memory of its own.

Implementations

impl<'a> Pack<'a>

pub fn open(bytes: &'a [u8], stamp: &str) -> Result<Self, PackError>

The pack bytes, every file unpacked, if it is of this engine’s VERSION, was baked with stamp, and holds together.

pub fn info(&self) -> &PackInfo

What the pack says of itself.

pub fn files(&self) -> &[PackFile<'a>]

Its files, in path order.

pub fn get(&self, path: &str) -> Option<&[u8]>

The bytes of the file at path, unpacked, if the pack has it.

pub fn into_owned(self) -> Pack<'static>

The pack, every file in memory of its own: for a pack read at run time, whose bytes the game doesn’t keep.

impl Pack<'static>

pub fn into_layer(self, name: &'static str) -> Layer

A bundle layer of the pack’s files, shown as name, standing for the bundle it was baked from (Layer::standing_for). A game opens its pack once, at start-up (most simply one it embeds with include_bytes!): the files it unpacked are kept for the rest of the run, as the files a game embeds are.

Trait Implementations

impl<'a> Clone for Pack<'a>

fn clone(&self) -> Pack<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Pack<'a>

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

Formats the value using the given formatter.

impl<'a> Eq for Pack<'a>

impl<'a> PartialEq for Pack<'a>

fn eq(&self, other: &Pack<'a>) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<'a> StructuralPartialEq for Pack<'a>