knbt/net.benwoodworth.knbt

Package-level declarations

Types

CompositeNbtDecoder

sealed interface CompositeNbtDecoder : CompositeDecoder

CompositeNbtEncoder

sealed interface CompositeNbtEncoder : CompositeEncoder

Nbt

sealed class Nbt : NbtFormat, BinaryFormat

NbtBuilder

class NbtBuilder : NbtFormatBuilder

Builder of the Nbt instance provided by Nbt { ... } factory function.

NbtByte

@JvmInline

@Serializable(with = NbtByteSerializer::class)

value class NbtByte(val value: Byte) : NbtTag

NbtByteArray

@Serializable(with = NbtByteArraySerializer::class)

class NbtByteArray : NbtTag, List<Byte>

NbtCompound

@Serializable(with = NbtCompoundSerializer::class)

class NbtCompound(content: Map<String, NbtTag>) : NbtTag, Map<String, NbtTag>

NbtCompoundBuilder

class NbtCompoundBuilder

NbtCompression

abstract class NbtCompression

NbtConfiguration

class NbtConfiguration : NbtFormatConfiguration

NbtContentPolymorphicSerializer

abstract class NbtContentPolymorphicSerializer<T : Any>(baseClass: KClass<T>) : KSerializer<T>

Base class for custom serializers that allows selecting polymorphic serializer without a dedicated class discriminator, on a content basis.

NbtDecoder

sealed interface NbtDecoder : Decoder

NbtDouble

@JvmInline

@Serializable(with = NbtDoubleSerializer::class)

value class NbtDouble(val value: Double) : NbtTag

NbtEncoder

sealed interface NbtEncoder : Encoder

NbtFloat

@JvmInline

@Serializable(with = NbtFloatSerializer::class)

value class NbtFloat(val value: Float) : NbtTag

NbtFormat

sealed interface NbtFormat : SerialFormat

NbtFormatBuilder

sealed interface NbtFormatBuilder

NbtFormatConfiguration

sealed interface NbtFormatConfiguration

NbtInt

@JvmInline

@Serializable(with = NbtIntSerializer::class)

value class NbtInt(val value: Int) : NbtTag

NbtIntArray

@Serializable(with = NbtIntArraySerializer::class)

class NbtIntArray : NbtTag, List<Int>

NbtList

@Serializable(with = NbtListSerializer::class)

class NbtList<out T : NbtTag> : NbtTag, List<T>

NbtListBuilder

class NbtListBuilder<T : NbtTag>

NbtLong

@JvmInline

@Serializable(with = NbtLongSerializer::class)

value class NbtLong(val value: Long) : NbtTag

NbtLongArray

@Serializable(with = NbtLongArraySerializer::class)

class NbtLongArray : NbtTag, List<Long>

NbtShort

@JvmInline

@Serializable(with = NbtShortSerializer::class)

value class NbtShort(val value: Short) : NbtTag

NbtString

@JvmInline

@Serializable(with = NbtStringSerializer::class)

value class NbtString(val value: String) : NbtTag

NbtTag

@Serializable(with = NbtTagSerializer::class)

sealed interface NbtTag

NbtTransformingSerializer

abstract class NbtTransformingSerializer<T : Any>(tSerializer: KSerializer<T>) : KSerializer<T>

Base class for custom serializers that allows manipulating an abstract NBT representation of the class before serialization or deserialization.

NbtVariant

abstract class NbtVariant

StringifiedNbt

sealed class StringifiedNbt : NbtFormat, StringFormat

StringifiedNbtBuilder

class StringifiedNbtBuilder : NbtFormatBuilder

Builder of the StringifiedNbt instance provided by StringifiedNbt { ... } factory function.

StringifiedNbtConfiguration

class StringifiedNbtConfiguration : NbtFormatConfiguration

Properties

nbtByte

val NbtTag.nbtByte: NbtByte

Convenience method to get this element as an NbtByte

nbtByteArray

val NbtTag.nbtByteArray: NbtByteArray

Convenience method to get this element as an NbtByteArray

nbtCompound

val NbtTag.nbtCompound: NbtCompound

Convenience method to get this element as an NbtCompound

nbtDouble

val NbtTag.nbtDouble: NbtDouble

Convenience method to get this element as an NbtDouble

nbtFloat

val NbtTag.nbtFloat: NbtFloat

Convenience method to get this element as an NbtFloat

nbtInt

val NbtTag.nbtInt: NbtInt

Convenience method to get this element as an NbtInt

nbtIntArray

val NbtTag.nbtIntArray: NbtIntArray

Convenience method to get this element as an NbtIntArray

nbtList

val NbtTag.nbtList: NbtList<*>

Convenience method to get this element as an NbtList

nbtLong

val NbtTag.nbtLong: NbtLong

Convenience method to get this element as an NbtLong

nbtLongArray

val NbtTag.nbtLongArray: NbtLongArray

Convenience method to get this element as an NbtLongArray

nbtShort

val NbtTag.nbtShort: NbtShort

Convenience method to get this element as an NbtShort

nbtString

val NbtTag.nbtString: NbtString

Convenience method to get this element as an NbtString

Functions

add

fun NbtListBuilder<NbtByteArray>.add(value: ByteArray): Boolean

fun NbtListBuilder<NbtByteArray>.add(tag: NbtByteArray): Boolean

fun NbtListBuilder<NbtByte>.add(value: Boolean): Boolean

fun NbtListBuilder<NbtByte>.add(value: Byte): Boolean

fun NbtListBuilder<NbtByte>.add(tag: NbtByte): Boolean

fun NbtListBuilder<NbtCompound>.add(tag: NbtCompound): Boolean

fun NbtListBuilder<NbtDouble>.add(value: Double): Boolean

fun NbtListBuilder<NbtDouble>.add(tag: NbtDouble): Boolean

fun NbtListBuilder<NbtFloat>.add(value: Float): Boolean

fun NbtListBuilder<NbtFloat>.add(tag: NbtFloat): Boolean

fun NbtListBuilder<NbtIntArray>.add(value: IntArray): Boolean

fun NbtListBuilder<NbtIntArray>.add(tag: NbtIntArray): Boolean

fun NbtListBuilder<NbtInt>.add(value: Int): Boolean

fun NbtListBuilder<NbtInt>.add(tag: NbtInt): Boolean

fun <T : NbtTag> NbtListBuilder<NbtList<T>>.add(tag: NbtList<T>): Boolean

fun NbtListBuilder<NbtLongArray>.add(value: LongArray): Boolean

fun NbtListBuilder<NbtLongArray>.add(tag: NbtLongArray): Boolean

fun NbtListBuilder<NbtLong>.add(value: Long): Boolean

fun NbtListBuilder<NbtLong>.add(tag: NbtLong): Boolean

fun NbtListBuilder<NbtShort>.add(value: Short): Boolean

fun NbtListBuilder<NbtShort>.add(tag: NbtShort): Boolean

fun NbtListBuilder<NbtString>.add(value: String): Boolean

fun NbtListBuilder<NbtString>.add(tag: NbtString): Boolean

addNbtCompound

inline fun NbtListBuilder<NbtCompound>.addNbtCompound(builderAction: NbtCompoundBuilder.() -> Unit): Boolean

addNbtList

@JvmName(name = "addNbtList$T")

inline fun <T : NbtTag> NbtListBuilder<NbtList<T>>.addNbtList(builderAction: NbtListBuilder<T>.() -> Unit): Boolean

inline fun <T : NbtTag> NbtListBuilder<NbtList<NbtTag>>.addNbtList(builderAction: NbtListBuilder<T>.() -> Unit): Boolean

asNbtDecoder

fun Decoder.asNbtDecoder(): NbtDecoder

asNbtEncoder

fun Encoder.asNbtEncoder(): NbtEncoder

buildNbtCompound

inline fun buildNbtCompound(builderAction: NbtCompoundBuilder.() -> Unit): NbtCompound

inline fun buildNbtCompound(name: String, builderAction: NbtCompoundBuilder.() -> Unit): NbtCompound

Build an NbtCompound suitable for being written to an NBT file.

buildNbtList

inline fun <T : NbtTag> buildNbtList(builderAction: NbtListBuilder<T>.() -> Unit): NbtList<T>

inline fun <T : NbtTag> buildNbtList(name: String, builderAction: NbtListBuilder<T>.() -> Unit): NbtCompound

Build an NbtList suitable for being written to an NBT file.

decodeFromNbtTag

inline fun <T> NbtFormat.decodeFromNbtTag(tag: NbtTag): T

Decodes and deserializes the given tag to a value of type T using serializer retrieved from the reified type parameter.

decodeFromSource

inline fun <T> Nbt.decodeFromSource(source: Source): T

Decode NBT from a Source.

decodeFromStream

inline fun <T> Nbt.decodeFromStream(input: InputStream): T

fun <T> Nbt.decodeFromStream(deserializer: DeserializationStrategy<T>, input: InputStream): T

Decode NBT from an InputStream.

detect

fun NbtCompression.Companion.detect(byteArray: ByteArray): NbtCompression

Peek in the byteArray and detect what NbtCompression is used.

fun NbtCompression.Companion.detect(source: BufferedSource): NbtCompression

Peek in the source and detect what NbtCompression is used.

fun NbtCompression.Companion.detect(stream: InputStream): NbtCompression

Peek in the stream and detect what NbtCompression is used.

encodeToNbtTag

inline fun <T> NbtFormat.encodeToNbtTag(value: T): NbtTag

Serializes and encodes the given value to an NbtTag using serializer retrieved from the reified type parameter.

encodeToSink

inline fun <T> Nbt.encodeToSink(value: T, sink: Sink)

Encode NBT to a Sink.

encodeToStream

inline fun <T> Nbt.encodeToStream(value: T, output: OutputStream)

fun <T> Nbt.encodeToStream(serializer: SerializationStrategy<T>, value: T, output: OutputStream)

Encode NBT to an OutputStream.

Nbt

fun Nbt(from: Nbt = DefaultNbt, builderAction: NbtBuilder.() -> Unit): Nbt

Creates an instance of Nbt configured from the optionally given Nbt instance and adjusted with builderAction.

nbtList

inline fun <T : NbtTag> NbtTag.nbtList(): NbtList<T>

Convenience method to get this element as an NbtList<T>

put

fun NbtCompoundBuilder.put(key: String, value: Boolean): NbtTag?

fun NbtCompoundBuilder.put(key: String, value: Byte): NbtTag?

fun NbtCompoundBuilder.put(key: String, value: ByteArray): NbtTag?

fun NbtCompoundBuilder.put(key: String, value: Double): NbtTag?

fun NbtCompoundBuilder.put(key: String, value: Float): NbtTag?

fun NbtCompoundBuilder.put(key: String, value: Int): NbtTag?

fun NbtCompoundBuilder.put(key: String, value: IntArray): NbtTag?

fun NbtCompoundBuilder.put(key: String, value: Long): NbtTag?

fun NbtCompoundBuilder.put(key: String, value: LongArray): NbtTag?

fun NbtCompoundBuilder.put(key: String, value: Short): NbtTag?

fun NbtCompoundBuilder.put(key: String, value: String): NbtTag?

putNbtCompound

inline fun NbtCompoundBuilder.putNbtCompound(key: String, builderAction: NbtCompoundBuilder.() -> Unit): NbtTag?

putNbtList

@JvmName(name = "putNbtList$T")

inline fun <T : NbtTag> NbtCompoundBuilder.putNbtList(key: String, builderAction: NbtListBuilder<T>.() -> Unit): NbtTag?

StringifiedNbt

fun StringifiedNbt(from: StringifiedNbt = StringifiedNbt.Default, builderAction: StringifiedNbtBuilder.() -> Unit): StringifiedNbt

Creates an instance of StringifiedNbt configured from the optionally given StringifiedNbt instance and adjusted with builderAction.