Struct rgssad::writer::Writer

pub struct Writer<W> { /* private fields */ }

The archive writer.

Implementations

impl<W> Writer<W>

pub fn new(writer: W) -> Writer<W>

Create an archive writer around a writer.

pub fn into_inner(self) -> W

Get the inner writer.

pub fn get_mut(&mut self) -> &mut W

Get a mutable ref to the inner writer.

impl<W> Writer<W>

where W: Write,

pub fn write_header(&mut self) -> Result<(), Error>

Write the archive header.

If the header has already been written, this is a NOP.

pub fn write_file<R>( &mut self, file_name: &str, file_size: u32, file_data: R, ) -> Result<(), Error>

where R: Read,

Write a file.

An file is composed of a name (path), size, and data. This function may be retried. To retry, call this function with the same arguments. Note that if anything other than an I/O error occurs, the written bytes are likely corrupted.

pub fn finish(&mut self) -> Result<(), Error>

Finish writing.

This is only a convenience function to call the inner Write object’s Write::flush method.

Trait Implementations

impl<W: Debug> Debug for Writer<W>

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

Formats the value using the given formatter.