Expand description
Read-only, low level, virtual file types for the RuneScape file system.
This crate supplies all of the backing types for rs-cache. Many of these types were private but are now publicly available. rs-cache is a high level api for both the OSRS and RS3 caches and exposing these low level virtual types didn’t make sense, hence this crate.
A word of caution, these types are highly experimental, I have done my best to document and test as much as I can, but there might still be the weird occasional edge-case. With that said, whenever you find a bug or missing feature; or even unsoundness don’t hesitate to open an issue.
Modules
(De)compression and enciphering/deciphering.
Error management.
In-place XTEA en/de-ciphering.
Structs
Holds an archive file id with its data.
Holds all of the archive files that belong to a single archive.
Metadata on every archive.
A reference to an archive segment.
A virtual file type for the .dat2 file.
Iterator to walk the archive reference chain.
A virtual file type for every .idx in the cache directory.
All of the index metadata read from the reference index.
A list of valid indices.
A section of data read from the Dat2 file.
A section header containing validation and its next sector.
Enums
Super error type for all runefs errors.
Used to convey a sector’s header size when parsing from a raw buffer.