Struct gma::GMAFile

pub struct GMAFile<ReaderType> where
    ReaderType: BufRead + Seek,  { /* fields omitted */ }

Implementations

impl<ReaderType> GMAFile<ReaderType> where
    ReaderType: BufRead + Seek, 

pub fn version(&self) -> u8

Get the gma archive versiom

pub fn appid(&self) -> u32

The appid. This is always '4000', the appid of garry's mod

pub fn author_steamid(&self) -> u64

The author's steamid. This is currently unused by the game and is usually hardcoded to 0

pub fn timestamp(&self) -> u64

The seconds since UNIX epoch from when the file was created

pub fn name(&self) -> &str

The name of the addon

pub fn description(&self) -> &str

The description of the addon

pub fn addon_type(&self) -> Option<AddonType>

The type of the addon

pub fn addon_tags(&self) -> &[AddonTag]

The tags of the item. This should be at most 2 but this implementation supports reading more

pub fn contains_tag(&self, tag: AddonTag) -> bool

Helper function to check if this addon contains a certain tag

pub fn author(&self) -> &str

The name of the addon's author

pub fn compressed(&self) -> bool

Returns true if the input file was compressed, false otherwise

pub fn entries(&self) -> impl Iterator<Item = &FileEntry>

An iterator of the file entries of this archive

pub fn read_entry<F, R>(&self, entry: &FileEntry, func: F) -> Result<R> where
    F: FnOnce(&FileEntry, &mut dyn Read) -> R, 

Function to read the contents of a given entry.

The callback function takes as parameter a reference to the entry and a mutable reference to a type that implements Read.

use std::io::Read;
let archive = gma::load_from_memory(&dummy_buffer).unwrap();
for entry in archive.entries() {
    let contents = archive.read_entry(entry, |entry_ref, reader|{
        let mut c = String::new();
        reader.read_to_string(&mut c).unwrap();
        c
    }).unwrap();
    // do something with contents
}

Trait Implementations

impl<ReaderType: Debug> Debug for GMAFile<ReaderType> where
    ReaderType: BufRead + Seek, 

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

Formats the value using the given formatter.