Struct sarc_rs::SarcWriter

pub struct SarcWriter {
    pub files: IndexMap<String, Vec<u8>>,
    /* private fields */
}

A simple SARC archive writer

Fields

files: IndexMap<String, Vec<u8>>

Files to be written.

Implementations

impl SarcWriter

pub fn new(endian: Endian) -> SarcWriter

A simple SARC archive writer

pub fn from_sarc(sarc: &Sarc<'_>) -> SarcWriter

Creates a new SARC writer by taking attributes and files from an existing SARC reader

pub fn write_to_bytes(&mut self) -> Result<Vec<u8>, SarcWriteError>

Write a SARC archive to an in-memory buffer using the specified endianness. Default alignment requirements may be automatically added.

pub fn write<W: Write + Seek>(
    &mut self,
    writer: &mut W
) -> Result<(), SarcWriteError>

Write a SARC archive to a Write + Seek writer using the specified endianness. Default alignment requirements may be automatically added.

pub fn add_alignment_requirement(
    &mut self,
    ext: String,
    alignment: usize
) -> Result<(), SarcWriteError>

Add or modify a data alignment requirement for a file type. Set the alignment to 1 to revert.

Arguments

• ext - File extension without the dot (e.g. “bgparamlist”)
• alignment - Data alignment (must be a power of 2)

pub fn set_min_alignment(
    &mut self,
    alignment: usize
) -> Result<(), SarcWriteError>

Set the minimum data alignment

pub fn set_legacy_mode(&mut self, value: bool)

Set whether to use legacy mode (for games without a BOTW-style resource system) for addtional alignment restrictions

pub fn set_endian(&mut self, endian: Endian)

Set the endianness

pub fn is_file_sarc(data: &[u8]) -> bool

Checks if a data slice represents a SARC archive

Trait Implementations

impl Clone for SarcWriter

fn clone(&self) -> SarcWriter

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SarcWriter

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

Formats the value using the given formatter.

impl PartialEq<SarcWriter> for SarcWriter

fn eq(&self, other: &SarcWriter) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &SarcWriter) -> bool

This method tests for !=.

impl Eq for SarcWriter

impl StructuralEq for SarcWriter

impl StructuralPartialEq for SarcWriter