Struct rscache::Cache

pub struct Cache<S: Store> { /* fields omitted */ }

Main cache struct providing basic utilities.

Implementations

impl<S: Store> Cache<S>

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

Constructs a new Cache<S> with the given store.

Errors

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

Examples

use rscache::{ Cache, store::MemoryStore };
 
let cache: Cache<MemoryStore> = Cache::new("./data/osrs_cache")?;

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

Reads from the internal store.

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.

Examples

let cache: Cache<MemoryStore> = Cache::new(path)?;
 
let index_id = 2; // Config index
let archive_id = 10; // Random archive.
 
let buffer = cache.read(index_id, archive_id)?;

pub fn read_archive(&self, archive: &ArchiveRef) -> Result<Vec<u8>>

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.

Examples

let checksum = cache.create_checksum()?;

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

Constructs a buffer which contains the huffman table.

Errors

Returns an error if the huffman archive could not be found or if the decode / decompression of the huffman table failed.

Examples

let huffman_table = cache.huffman_table()?;
let huffman = Huffman::new(huffman_table);

pub fn archive_by_name<T: Into<String>>(
    &self,
    index_id: u8,
    name: T
) -> Result<ArchiveRef>

Searches for the archive which contains the given name hash in the given index_id.

Errors

Panics if the string couldn’t be hashed by the djd2 hasher.

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.
Returns an NameNotInArchive error if the name hash is not present in this archive.

Examples

let index_id = 10;
let archive = cache.archive_by_name(index_id, "huffman")?;

pub fn index_count(&self) -> usize

Simply returns the index count, by getting the len() of the underlying indices vector.

Examples

for index in 0..cache.index_count() {
    // ...
}
 
assert_eq!(22, cache.index_count());

pub fn indices(&self) -> &Indices

Trait Implementations

impl<S: Store> CacheCore for Cache<S>

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

impl<S: Store> CacheRead for Cache<S>

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

fn read_archive(&self, archive: &ArchiveRef) -> Result<Vec<u8>>

impl<S: Clone + Store> Clone for Cache<S>

fn clone(&self) -> Cache<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Debug + Store> Debug for Cache<S>

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

Formats the value using the given formatter.