Struct rs3cache_backend::index::CacheIndex

pub struct CacheIndex<S: IndexState> { /* private fields */ }

Container of Archives.

Implementations

impl CacheIndex<Initial>

pub fn new(index_id: u32, input: CachePath) -> CacheResult<CacheIndex<Initial>>

Constructor for CacheIndex.

Errors

Raises CacheNotFoundError if the cache database cannot be found.

impl<S> CacheIndex<S>where S: IndexState,

pub fn get_file(&self, metadata: &Metadata) -> CacheResult<Bytes>

Executes a sql command to retrieve an archive from the cache.

pub fn assert_coherence(&self) -> Result<(), IntegrityError>

Assert whether the cache held by self is in a coherent state.

Errors

May raise CrcError, VersionError or ArchiveNotFoundError if the cache is not in a logical state.

Notes

Indices VORBIS, AUDIOSTREAMS, TEXTURES_PNG_MIPPED and TEXTURES_ETC tend to never complete. For these, simply ignore ArchiveNotFoundError.

impl<S> CacheIndex<S>where S: IndexState,

pub fn index_id(&self) -> u32

The index id of self, corresponding to the raw/js5-{index_id}.jcache file being held.

pub fn metadatas(&self) -> &IndexMetadata

Returns a view over the IndexMetadata of self.

pub fn archive(&self, archive_id: u32) -> CacheResult<Archive>

Get an Archive from self.

Errors

Raises ArchiveNotFoundError if archive_id is not in self.

impl CacheIndex<Initial>

pub fn retain(self, ids: Vec<u32>) -> CacheIndex<Truncated>

Retain only those archives that are in ids. Advances self to the Truncated state.

Panics

Panics if any of ids is not in self.

Trait Implementations

impl IntoIterator for CacheIndex<Initial>

type Item = Result<Archive, CacheError>

The type of the elements being iterated over.

type IntoIter = IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoIterator for CacheIndex<Truncated>

type Item = Result<Archive, CacheError>

The type of the elements being iterated over.

type IntoIter = IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.