Struct rstb::ResourceSizeTable

pub struct ResourceSizeTable { /* fields omitted */ }

A representation of a Breath of the Wild Resource Size Table (RSTB) file

Implementations

impl ResourceSizeTable

pub fn new() -> ResourceSizeTable

Creates a new, blank RSTB. Probably not very useful, to be honest.

pub fn new_from_stock(endian: Endian) -> ResourceSizeTable

Creates a new copy of a stock BOTW RSTB. Passing Endian::Big will return the RSTB from the 1.5.0 Wii U version, and passing Endian::Little will return the RSTB from the 1.6.0 Switch version.

pub fn to_text(&self) -> Result<String, Error>

Creates a text representation of an RSTB as a JSON string.

pub fn from_text(text: &str) -> Result<ResourceSizeTable, Error>

Reads an RSTB from a JSON representation.

impl ResourceSizeTable

pub fn from_binary<B: AsRef<[u8]>>(
    data: B,
    endian: Endian
) -> Result<ResourceSizeTable, Error>

Parses an RSTB file from a buffer implementing Into<Vec<u8>> using the specified endianness. If the data is yaz0 compressed, it will be decompressed automatically.

pub fn write_binary<W: Write>(
    &self,
    writer: &mut W,
    endian: Endian
) -> Result<(), Error>

Writes the contents of an RSTB to a binary writer implementing Write. Does not yaz0 compress, this is left to the user.

pub fn to_binary(
    &self,
    endian: Endian,
    compress: bool
) -> Result<Vec<u8>, Error>

Writes the binary content of an RSTB as Vec<u8>, optionally with yaz0 compression.

pub fn name_entries(&self) -> Iter<'_, String, u32>

Iterates entries in the RSTB’s name table.

pub fn hash_entries(&self) -> Iter<'_, u32, u32>

Iterates entries in the RSTB’s CRC table.

pub fn get_size(&self, file: &str) -> Option<u32>

Attempts to retrieve the resource size of a file in the RSTB, returning None if there is no entry for the file. Checks the CRC table first and then the name table.

pub fn is_in_table(&self, file: &str) -> bool

Checks whether a file has an entry in the RSTB. Checks the CRC table first and then the name table.

pub fn set_size<I: Into<u32>>(&mut self, file: &str, size: I)

Sets the resource size of a file in the RSTB, adding an entry if one is not already present. Uses the CRC table only.

pub fn delete_entry(&mut self, file: &str)

Deletes an entry from the RSTB. Does nothing if the entry does not exist. Checks the CRC table first and then the name table.

Trait Implementations

impl BinRead for ResourceSizeTable

type Args = (usize,)

The type of arguments needed to be supplied in order to read this type, usually a tuple.

fn read_options<R: Read + Seek>(
    __binread_generated_var_reader: &mut R,
    __binread_generated_var_options: &ReadOptions,
    __binread_generated_var_arguments: Self::Args
) -> BinResult<Self>

Read the type from the reader

fn read<R>(reader: &mut R) -> Result<Self, Error> where
    R: Read + Seek, 

Read the type from the reader while assuming no arguments have been passed

fn read_args<R>(reader: &mut R, args: Self::Args) -> Result<Self, Error> where
    R: Read + Seek, 

Read the type from the reader using the specified arguments

fn after_parse<R>(
    &mut self,
    &mut R,
    &ReadOptions,
    Self::Args
) -> Result<(), Error> where
    R: Read + Seek, 

fn args_default() -> Option<Self::Args>

The default arguments to be used when using the read shortcut method. Override this for any type that optionally requries arguments

impl Clone for ResourceSizeTable

fn clone(&self) -> ResourceSizeTable

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ResourceSizeTable

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

Formats the value using the given formatter.

impl Default for ResourceSizeTable

fn default() -> ResourceSizeTable

Returns the “default value” for a type.

impl PartialEq<ResourceSizeTable> for ResourceSizeTable

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

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

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

This method tests for !=.

impl StructuralPartialEq for ResourceSizeTable