Struct sarc::SarcFile

pub struct SarcFile {
    pub byte_order: Endian,
    pub files: Vec<SarcEntry>,
}

An in-memory representation of a Sarc archive

Fields

byte_order: Endian

files: Vec<SarcEntry>

Implementations

impl SarcFile

pub fn read_from_file<P: AsRef<Path>>(path: P) -> Result<Self, Error>

Read a sarc file (with or without compression) from a file.

Note: Compression requires the yaz0_sarc and/or the zstd_sarc features.

pub fn read(data: &[u8]) -> Result<Self, Error>

Read a sarc file (with or without compression) from a byte slice.

Note: Compression requires the yaz0_sarc and/or the zstd_sarc features.

impl SarcFile

pub fn write_to_file<P: AsRef<Path>>(&self, path: P) -> Result<()>

Write

pub fn write_to_compressed_file<P: AsRef<Path>>(
    &self,
    path: P
) -> Result<(), Error>

Write to a compressed file. This writes the SARC with yaz0 compression. Requires either the yaz0_sarc feature or zstd_sarc feature enabled.

Note: If yaz0 compression is disabled and zstd compression is enabled, this will write with zstd compression.

pub fn write_to_yaz0_file<P: AsRef<Path>>(&self, path: P) -> Result<(), Error>

Write to a compressed file. This writes the SARC with yaz0 compression. Requires yaz0_sarc feature

pub fn write_yaz0<W: Write>(&self, f: &mut W) -> Result<(), Error>

Write to a writer that implements std::io::Write. This writes the SARC with yaz0 compression. Requires yaz0_sarc feature.

pub fn write_zstd<W: Write>(&self, f: &mut W) -> Result<(), Error>

Write to a writer that implements std::io::Write. This writes the SARC with zstd compression. Requires zstd_sarc feature.

pub fn write<W: Write>(&self, f: &mut W) -> Result<()>

Write to a writer that implements std::io::Write. This writes the SARC with no compression.

Trait Implementations

impl Debug for SarcFile

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

Formats the value using the given formatter.