Struct veloren_common_assets::source::Tar

pub struct Tar<R = SyncFile> {
    reader: R,
    files: HashMap<FileDesc, (u64, u64)>,
    dirs: HashMap<SharedString, Vec<OwnedEntry>>,
    label: Option<String>,
}

A [Source] to load assets from a tar archive.

The archive can be backed by any reader that also implements io::Seek and Clone.

Warning: This will clone the reader each time it is read, so you should ensure that is cheap to clone (eg not Vec<u8>).

Fields

reader: R

files: HashMap<FileDesc, (u64, u64)>

dirs: HashMap<SharedString, Vec<OwnedEntry>>

label: Option<String>

Implementations

impl Tar

pub fn open<P>(path: P) -> Result<Tar, Error>

where P: AsRef<Path>,

Creates a Zip archive backed by the file at the given path.

impl<T> Tar<Cursor<T>>

where T: AsRef<[u8]>,

pub fn from_bytes(bytes: T) -> Result<Tar<Cursor<T>>, Error>

Creates a Tar archive backed by a byte buffer in memory.

pub fn from_bytes_with_label( bytes: T, label: String, ) -> Result<Tar<Cursor<T>>, Error>

Creates a Tar archive backed by a byte buffer in memory.

impl<R> Tar<R>

where R: Read + Seek,

pub fn from_reader(reader: R) -> Result<Tar<R>, Error>

Creates a Tar archive backed by a reader that supports seeking.

pub fn from_reader_with_label(reader: R, label: String) -> Result<Tar<R>, Error>

Creates a Tar archive backed by a reader that supports seeking.

An additionnal label that will be used in errors can be added.

Trait Implementations

impl<R> Debug for Tar<R>

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

Formats the value using the given formatter.

impl<R> Source for Tar<R>

where R: Read + Seek + Clone,

fn read(&self, id: &str, ext: &str) -> Result<FileContent<'_>, Error>

Try reading the source given an id and an extension.

fn read_dir( &self, id: &str, f: &mut dyn FnMut(DirEntry<'_>), ) -> Result<(), Error>

Reads the content of a directory.

fn exists(&self, entry: DirEntry<'_>) -> bool

Returns true if the entry points at an existing entity.

fn make_source(&self) -> Option<Box<dyn Source + Send>>

Returns a source to use with hot-reloading.

fn configure_hot_reloading( &self, _events: EventSender, ) -> Result<(), Box<dyn Error + Send + Sync>>

Configures hot-reloading.