Struct sarc_rs::Sarc

source · [−]

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

Expand description

A simple SARC archive reader

Implementations

source

impl<'a> Sarc<'_>

source

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

Parses a SARC archive from binary data

source

pub fn file_count(&self) -> usize

Get the number of files that are stored in the archive

source

pub fn data_offset(&self) -> usize

Get the offset to the beginning of file data

source

pub fn endian(&self) -> Endian

Get the archive endianness

source

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

Get a file by name

source

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

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

source

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

Returns an iterator over the contained files

source

pub fn guess_min_alignment(&self) -> usize

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

source

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

Returns true is each archive contains the same files

Trait Implementations

source

impl<'a> Clone for Sarc<'a>

source

fn clone(&self) -> Self

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

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

source

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

Formats the value using the given formatter. Read more

source

impl Hash for Sarc<'_>

source

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more

1.3.0 · source

fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,

Feeds a slice of this type into the given Hasher. Read more

source

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

source

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

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

1.0.0 · source

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

This method tests for !=.

source

impl Eq for Sarc<'_>

Auto Trait Implementations

impl<'a> RefUnwindSafe for Sarc<'a>

impl<'a> Send for Sarc<'a>

impl<'a> Sync for Sarc<'a>

impl<'a> Unpin for Sarc<'a>

impl<'a> UnwindSafe for Sarc<'a>

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

source

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct sarc_rs::Sarc

Implementations

impl<'a> Sarc<'_>

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

pub fn file_count(&self) -> usize

pub fn data_offset(&self) -> usize

pub fn endian(&self) -> Endian

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

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

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

pub fn guess_min_alignment(&self) -> usize

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

Trait Implementations

impl<'a> Clone for Sarc<'a>

fn clone(&self) -> Self

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

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

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

impl Hash for Sarc<'_>

fn hash<H: Hasher>(&self, state: &mut H)

fn hash_slice<H>(data: &[Self], state: &mut H) where H: Hasher,

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

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

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

impl Eq for Sarc<'_>

Auto Trait Implementations

impl<'a> RefUnwindSafe for Sarc<'a>

impl<'a> Send for Sarc<'a>

impl<'a> Sync for Sarc<'a>

impl<'a> Unpin for Sarc<'a>

impl<'a> UnwindSafe for Sarc<'a>

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<Q, K> Equivalent<K> for Q where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,