openrs2/org.openrs2.cache/FlatFileStore

FlatFileStore

class FlatFileStore : Store

A Store implementation that represents archives as file system directories and groups as file system files. This format is much friendlier to content-addressable version control systems, such as Git, than the native format used by the client.

Multiple read threads may use this class simultaneously. However, only a single thread may write at a time. Reads and writes must not happen simultaneously.

Types

object Companion

Functions

open override fun close()

open override fun create(archive: Int)

Creates an archive. Does nothing if the archive already exists.

open override fun exists(archive: Int): Boolean

Checks whether an archive exists.

open override fun exists(archive: Int, group: Int): Boolean

Checks whether a group exists.

open override fun flush()

open override fun list(): List<Int>

Lists all archives in the store.

open override fun list(archive: Int): List<Int>

Lists all groups in an archive.

open override fun read(archive: Int, group: Int): ByteBuf

Reads a group.

open override fun remove(archive: Int)

Deletes an archive and all groups contained inside it. Does nothing if the archive does not exist.

open override fun remove(archive: Int, group: Int)

Deletes a group. Does nothing if the archive or group does not exist.

open override fun write(archive: Int, group: Int, buf: ByteBuf)

Writes a group. If the archive does not exist, it is created first. If a group with the same ID already exists, it is overwritten.