Struct rscache::Cache

pub struct Cache { /* fields omitted */ }

A parsed Jagex cache.

Implementations

impl Cache

pub fn new<P: AsRef<Path>>(path: P) -> Result<Self>

Constructs a new Cache.

Each valid index is parsed and stored, and in turn all archive references as well. If an index is not present it will simply be skipped. However, the main data file and reference table both are required.

Errors

If this function encounters any form of I/O or other error, a CacheError is returned which wraps the underlying error.

pub fn read(&self, index_id: u8, archive_id: u32) -> Result<Vec<u8>>

Reads from the internal data.

A lookup is performed on the specified index to find the sector id and the total length of the buffer that needs to be read from the main_file_cache.dat2.

If the lookup is successfull the data is gathered into a Vec<u8>.

Errors

Returns an IndexNotFound error if the specified index_id is not a valid Index.
Returns an ArchiveNotFound error if the specified archive_id is not a valid Archive.

pub fn read_into_writer<W: Write>(
    &self,
    index_id: u8,
    archive_id: u32,
    writer: &mut W
) -> Result<()>

Reads bytes from the cache into the given writer.

This will not allocate a buffer but use the writer instead, see read

Errors

Returns an IndexNotFound error if the specified index_id is not a valid Index.
Returns an ArchiveNotFound error if the specified archive_id is not a valid Archive.

pub fn create_checksum(&self) -> Result<Checksum>

Creates a Checksum which can be used to validate the cache data that the client received during the update protocol.

NOTE: The RuneScape client doesn’t have a valid crc for index 16. This checksum sets the crc and version for index 16 both to 0. The crc for index 16 should be skipped.

Errors

Returns an error when a buffer read from the reference table could not be decoded / decompressed.

pub fn huffman_table(&self) -> Result<Vec<u8>>

Tries to return the huffman table from the cache.

This can be used to (de)compress chat messages, see Huffman.

pub fn index_count(&self) -> usize

Trait Implementations

impl Debug for Cache

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

Formats the value using the given formatter.