Struct sarc_rs::Sarc

pub struct Sarc<'a> { /* fields omitted */ }

A simple SARC archive reader

Implementations

impl<'a> Sarc<'_>

pub fn new(data: &'a [u8]) -> Result<Sarc<'a>, SarcError>

Parses a SARC archive from binary data

pub fn file_count(&self) -> usize

Get the number of files that are stored in the archive

pub fn data_offset(&self) -> usize

Get the offset to the beginning of file data

pub fn endian(&self) -> Endian

Get the archive endianness

pub fn get_file(&self, file: &str) -> Result<Option<File<'_>>, SarcError>

Get a file by name

pub fn file_at(&self, index: usize) -> Result<File<'_>, SarcError>

Get a file by index. Returns error if index > file count.

pub fn files(&self) -> impl Iterator<Item = File<'_>>

Returns an iterator over the contained files

pub fn guess_min_alignment(&self) -> usize

Guess the minimum data alignment for files that are stored in the archive

pub fn are_files_equal(sarc1: &Sarc<'_>, sarc2: &Sarc<'_>) -> bool

Returns true is each archive contains the same files

Trait Implementations

impl<'a> Debug for Sarc<'a>

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

Formats the value using the given formatter.

impl PartialEq<Sarc<'_>> for Sarc<'_>

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

Returns true if and only if the raw archive data is identical

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.