Struct screen_13::pak::Pak

pub struct Pak<R> where
    R: Read + Seek,  { /* fields omitted */ }

A wrapper type which allows callers to specify the Read and Seek implementations used to read assets.

Programs may specify their own implementations with a type definition. For a buffered file which handles content re-reads better on systems with enough memory:

type PakFile = Pak<BufReader<File>>;

Or for a basic implementation, one which would be compatible with the ECS sample code which contains bespoke data buffering:

type PakFile = Pak<File>;

Most programs will want to use the provided open(...) function of Pak<BufReader<File>>, which provides a buffered file-based .pak asset reader.

Examples

use {screen_13::prelude_all::*, std::io::Error};

fn main() -> Result<(), Error> {
    // This buffers the file so we don't have to re-read the data from disk if the asset is
    // re-read. TODO: work on an option for people who don't want buffered IO. 🚧
    let pak = Pak::open("/home/john/Desktop/foo.pak")?;
    ...
}

Implementations

impl Pak<BufReader<File>>

pub fn open<P: AsRef<Path>>(path: P) -> Result<Self, Error>

Opens the given path and decodes a Pak.

impl<R> Pak<R> where
    R: Read + Seek, 

pub fn animation_id<K: AsRef<str>>(&self, key: K) -> Option<AnimationId>

Gets the pak-unique AnimationId corresponding to the given key, if one exsits.

pub fn bitmap_id<K: AsRef<str>>(&self, key: K) -> Option<BitmapId>

Gets the pak-unique BitmapId corresponding to the given key, if one exsits.

pub fn bitmap_font_id<K: AsRef<str>>(&self, key: K) -> Option<BitmapFontId>

Gets the pak-unique BitmapFontId corresponding to the given key, if one exsits.

pub fn blob_id<K: AsRef<str>>(&self, key: K) -> Option<BlobId>

Gets the pak-unique BlobId corresponding to the given key, if one exsits.

pub fn material_id<K: AsRef<str>>(&self, key: K) -> Option<MaterialId>

Gets the pak-unique MaterialId corresponding to the given key, if one exsits.

pub fn material<K: AsRef<str>>(&self, key: K) -> Material

Gets the material for the given key.

pub fn material_with_id(&self, id: MaterialId) -> Material

Gets the material with the given id.

pub fn model_id<K: AsRef<str>>(&self, key: K) -> Option<ModelId>

Gets the pak-unique ModelId corresponding to the given key, if one exsits.

pub fn scene_id<K: AsRef<str>>(&self, key: K) -> Option<SceneId>

Gets the pak-unique SceneId corresponding to the given key, if one exsits.

pub fn text<K: AsRef<str>>(&self, key: K) -> Cow<'_, str>

Gets the text corresponding to the given key. Panics if the key doesn't exist.

pub fn text_id<K: AsRef<str>>(&self, key: K) -> Option<TextId>

Gets the pak-unique TextId corresponding to the given key, if one exsits.

pub fn text_locale<K: AsRef<str>, L: AsRef<str>>(
    &self,
    key: K,
    locale: L
) -> Cow<'_, str>

Gets the localized text corresponding to the given key and locale. Panics if the key doesn't exist.

pub fn text_raw<K: AsRef<str>>(&self, key: K) -> Cow<'_, str>

Gets the text corresponding to the given key. Panics if the key doesn't exist.

pub fn read_blob(&mut self, id: BlobId) -> Vec<u8>

Reads the corresponding blob for the given id.

pub fn read_scene(&mut self, id: SceneId) -> Scene

Reads the corresponding scene for the given id.