Fdic/com.darkrockstudios.fdic

Package-level declarations

The .fdic format: the FrequencyDictionary model, FrequencyDictionaryIO read/write, the FrequencyDictionaryFileFormat constants, and the FdicException hierarchy.

Types

FdicException

sealed class FdicException : Exception

Base type for all errors raised while reading or writing .fdic files.

FdicFormatException

class FdicFormatException(msg: String) : FdicException

Thrown when a .fdic file is malformed or has an unsupported format.

FdicValidationException

class FdicValidationException(msg: String) : FdicException

Thrown when a dictionary's header fields fail validation.

FrequencyDictionary

data class FrequencyDictionary(val formatVersion: Int = FORMAT_VERSION.toInt(), val ngrams: Int, val locale: String, val termCount: Int, val terms: MutableMap<String, Long> = mutableMapOf<String, Long>())

An in-memory frequency dictionary as decoded from a .fdic file.

FrequencyDictionaryFileFormat

object FrequencyDictionaryFileFormat

On-disk constants and header helpers for the .fdic file format.

FrequencyDictionaryIO

expect object FrequencyDictionaryIO

Reads and writes FrequencyDictionary data in the .fdic file format.

actual object FrequencyDictionaryIO

Reads and writes FrequencyDictionary data in the .fdic file format.

actual object FrequencyDictionaryIO

Reads and writes FrequencyDictionary data in the .fdic file format.

Functions

readDelimitedString

fun FastByteArrayInputStream.readDelimitedString(): String

writeDelimitedString

suspend fun ByteArrayBuilder.writeDelimitedString(str: String)