openrs2/org.openrs2.cache/Cache

Cache

class Cache : Flushable, Closeable

A high-level interface for reading and writing files to and from a collection of JS5 archives.

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
fun capacity(archive: Int): Int
fun capacity(archive: Int, group: Int): Int
fun capacity(archive: Int, group: String): Int
Link copied to clipboard
fun capacityNamed(archive: Int, groupNameHash: Int): Int
Link copied to clipboard
fun clear()

Writes pending changes back to the underlying Store and clears the internal group cache.

Link copied to clipboard
open override fun close()
Link copied to clipboard
fun create(archive: Int)
Link copied to clipboard
fun exists(archive: Int): Boolean
fun exists(archive: Int, group: Int): Boolean
fun exists(archive: Int, group: String): Boolean
fun exists(archive: Int, group: Int, file: Int): Boolean
fun exists(archive: Int, group: String, file: Int): Boolean
fun exists(archive: Int, group: String, file: String): Boolean
Link copied to clipboard
fun existsNamed(archive: Int, groupNameHash: Int): Boolean
fun existsNamed(archive: Int, groupNameHash: Int, fileNameHash: Int): Boolean
Link copied to clipboard
fun existsNamedGroup(archive: Int, groupNameHash: Int, file: Int): Boolean
Link copied to clipboard
open override fun flush()

Writes pending changes back to the underlying Store.

Link copied to clipboard
fun list(): Iterator<Int>
fun list(archive: Int): Iterator<Js5Index.Group<*>>
fun list(archive: Int, group: Int): Iterator<Js5Index.File>
fun list(archive: Int, group: String): Iterator<Js5Index.File>
Link copied to clipboard
fun listNamed(archive: Int, groupNameHash: Int): Iterator<Js5Index.File>
Link copied to clipboard
@JvmOverloads
fun read(archive: Int, group: Int, file: Int, key: XteaKey = XteaKey.ZERO): ByteBuf
@JvmOverloads
fun read(archive: Int, group: String, file: Int, key: XteaKey = XteaKey.ZERO): ByteBuf
@JvmOverloads
fun read(archive: Int, group: String, file: String, key: XteaKey = XteaKey.ZERO): ByteBuf
Link copied to clipboard
@JvmOverloads
fun readNamed(archive: Int, groupNameHash: Int, fileNameHash: Int, key: XteaKey = XteaKey.ZERO): ByteBuf
Link copied to clipboard
@JvmOverloads
fun readNamedGroup(archive: Int, groupNameHash: Int, file: Int, key: XteaKey = XteaKey.ZERO): ByteBuf
Link copied to clipboard
fun remove(archive: Int)
fun remove(archive: Int, group: Int)
fun remove(archive: Int, group: String)
@JvmOverloads
fun remove(archive: Int, group: Int, file: Int, key: XteaKey = XteaKey.ZERO)
@JvmOverloads
fun remove(archive: Int, group: String, file: Int, key: XteaKey = XteaKey.ZERO)
@JvmOverloads
fun remove(archive: Int, group: String, file: String, key: XteaKey = XteaKey.ZERO)
Link copied to clipboard
fun removeNamed(archive: Int, groupNameHash: Int)
@JvmOverloads
fun removeNamed(archive: Int, groupNameHash: Int, fileNameHash: Int, key: XteaKey = XteaKey.ZERO)
Link copied to clipboard
@JvmOverloads
fun removeNamedGroup(archive: Int, groupNameHash: Int, file: Int, key: XteaKey = XteaKey.ZERO)
Link copied to clipboard
@JvmOverloads
fun write(archive: Int, group: Int, file: Int, buf: ByteBuf, key: XteaKey = XteaKey.ZERO)
@JvmOverloads
fun write(archive: Int, group: String, file: Int, buf: ByteBuf, key: XteaKey = XteaKey.ZERO)
@JvmOverloads
fun write(archive: Int, group: String, file: String, buf: ByteBuf, key: XteaKey = XteaKey.ZERO)
Link copied to clipboard
@JvmOverloads
fun writeNamed(archive: Int, groupNameHash: Int, fileNameHash: Int, buf: ByteBuf, key: XteaKey = XteaKey.ZERO)
Link copied to clipboard
@JvmOverloads
fun writeNamedGroup(archive: Int, groupNameHash: Int, file: Int, buf: ByteBuf, key: XteaKey = XteaKey.ZERO)