mew-tea-f8-core/me.nullicorn.mewteaf8

Package-level declarations

Utilities for getting the size, in bytes, of an individual Char, CharArray, or CharSequence when encoded as Modified UTF-8 data. For the sake of brevity, this is referred to as the mutf8Length (Modified UTF-8 length).

JVM-specific utilities for Modified UTF-8 I/O with Java's InputStream and OutputStream classes

Types

EOFException

expect open class EOFException(message: String) : IOException

Thrown when the end of a binary sequence is reached earlier than expected while reading.

actual typealias EOFException = EOFException

actual open class EOFException(message: String) : IOException

IOException

expect open class IOException(message: String, cause: Throwable? = null) : Exception

Thrown when issue occurs while trying to read or write data to an external location, like a file or network socket.

actual typealias IOException = IOException

actual open class IOException(message: String, cause: Throwable?) : Exception

Mutf8Sink

abstract class Mutf8Sink(bytesPerWrite: Int = 1024)

Something that Modified UTF-8 data can be written to.

Mutf8Source

abstract class Mutf8Source

Something that Modified UTF-8 data can be read from.

StreamMutf8Sink

class StreamMutf8Sink(stream: OutputStream, bytesPerWrite: Int = 1024) : Mutf8Sink

A Mutf8Sink that writes its data to an OutputStream.

StreamMutf8Source

class StreamMutf8Source(stream: InputStream) : Mutf8Source

A Mutf8Source that reads its data from an InputStream.

UTFDataFormatException

expect open class UTFDataFormatException(message: String) : IOException

Thrown when malformed Modified UTF-8 data is read.

actual typealias UTFDataFormatException = UTFDataFormatException

actual open class UTFDataFormatException(message: String) : IOException

Functions

mutf8Length

@JvmName(name = "of")

fun CharArray.mutf8Length(startIndex: Int = 0, endIndex: Int = size): Long

The summed mutf8Length for the characters in a subsection of this array.

@JvmName(name = "of")

fun CharSequence.mutf8Length(startIndex: Int = 0, endIndex: Int = length): Long

The summed mutf8Length for the characters in a subsequence of this one.

readMutf8Array

@JvmName(name = "readArrayFrom")

fun InputStream.readMutf8Array(): CharArray

Creates a StreamMutf8Source around the receiver, reads the length & contents of a Modified UTF-8 string, and then returns the contents as a CharArray.

readMutf8String

@JvmName(name = "readStringFrom")

fun InputStream.readMutf8String(): String

Creates a StreamMutf8Source around the receiver, reads the length & contents of a Modified UTF-8 string, and then returns the contents as a String.

readMutf8ToAppendable

@JvmName(name = "readToAppendableFrom")

fun InputStream.readMutf8ToAppendable(destination: Appendable)

Creates a StreamMutf8Source around the receiver, reads the length & contents of a Modified UTF-8 string, and then writes those contents to the supplied destination, such as a StringBuilder.

writeMutf8Array

fun OutputStream.writeMutf8Array(characters: CharArray, range: IntRange = 0..characters.lastIndex, bytesPerWrite: Int = DEFAULT_BYTES_PER_WRITE)

@JvmName(name = "writeArrayTo")

@JvmOverloads

fun OutputStream.writeMutf8Array(characters: CharArray, startIndex: Int = 0, endIndex: Int = characters.size, bytesPerWrite: Int = DEFAULT_BYTES_PER_WRITE)

Creates a StreamMutf8Sink around the receiver, writes the mutf8Length of the characters, and then writes the characters themselves.

writeMutf8Sequence

fun OutputStream.writeMutf8Sequence(characters: CharSequence, range: IntRange = 0..characters.lastIndex, bytesPerWrite: Int = DEFAULT_BYTES_PER_WRITE)

@JvmName(name = "writeSequenceTo")

@JvmOverloads

fun OutputStream.writeMutf8Sequence(characters: CharSequence, startIndex: Int = 0, endIndex: Int = characters.length, bytesPerWrite: Int = DEFAULT_BYTES_PER_WRITE)

Creates a StreamMutf8Sink around the receiver, writes the mutf8Length of the characters, and then writes the characters themselves.

Properties

mutf8Length

@get:JvmName(name = "of")

val Char.mutf8Length: Int

The number of bytes used to encode the character in a Modified UTF-8 sequence.

@get:JvmName(name = "of")

val CharSequence.mutf8Length: Long

The summed mutf8Length for all the characters in the sequence.

@get:JvmName(name = "of")

val CharArray.mutf8Length: Long

The summed mutf8Length for all the characters in the array.