Struct gma::GMABuilder

pub struct GMABuilder { /* fields omitted */ }

GMA File Builder.

The only required fields are ‘name’ and ‘addon_tag’

Implementations

impl GMABuilder

pub fn new() -> Self

Creates a new gma builder

pub fn version(&mut self, version: u8) -> &mut Self

Sets the gma version of the archive. Default : 3

pub fn steamid(&mut self, steamid: u64) -> &mut Self

Sets the steamid of the author. Default : 0

pub fn timestamp(&mut self, timestamp: u64) -> &mut Self

Sets the timestamp. Default : current time

pub fn name<S: Into<String>>(&mut self, name: S) -> &mut Self

Sets the name of the addon. Required

pub fn description<S: Into<String>>(&mut self, description: S) -> &mut Self

Sets the description of the addon. Default : ‘’

pub fn author<S: Into<String>>(&mut self, author: S) -> &mut Self

Sets the name of the author. Default : ‘unknown’

pub fn compression(&mut self, c: bool) -> &mut Self

Enables or disables lzma compression. Default : false

Garry’s mod doesnt open compressed gma files. Support for compressed files is mostly here to interact with files downloaded straight from the steamworkshop that could be compressed

pub fn addon_type(&mut self, addon_type: AddonType) -> &mut Self

Sets the addon type. Required

pub fn addon_tag(&mut self, addon_tag: AddonTag) -> &mut Self

Adds tag to the addon. Only 2 tags are allowed at any given time, adding more will replace the oldest one

pub fn file_from_path<S: AsRef<Path>>(
    &mut self,
    path: S
) -> Result<&mut Self, Error>

Adds a file to the archive from the provided path

pub fn file_with_name<P: AsRef<Path>, N: Into<String>>(
    &mut self,
    path: P,
    name: N
) -> Result<&mut Self, Error>

pub fn file_from_bytes<S: Into<String>>(
    &mut self,
    filename: S,
    bytes: Vec<u8>
) -> &mut Self

Adds a file with the given filename and contents

pub fn file_from_reader<S: Into<String>, R: Read + 'static>(
    &mut self,
    filename: S,
    reader: R
) -> &mut Self

Adds a file with the given filename and contents are read from reader

pub fn write_to<WriterType>(self, writer: WriterType) -> Result<()> where
    WriterType: Write + Seek, 

Consumes the builder and writes the gma file contents to the given writer