nbt

Documentation

Overview

package nbt is a library for working with Minecraft nbt files. encoding is not supported yet.

Index

• Variables
• func Marshal(v interface{}) ([]byte, error)
• func Unmarshal(b []byte, v interface{}) (err error)
• type Decoder
  • func NewDecoder(r io.Reader) *Decoder
  • func (d *Decoder) Decode(v interface{}) (err error)
• type Encoder
  • func NewEncoder(w io.Writer) *Encoder
  • func (e *Encoder) Encode(v interface{}) error

Variables

var (
	ErrInvalidUnmarshalType = errors.New("trying to unmarshal into wrong type")
)

Functions

func Marshal

func Marshal(v interface{}) ([]byte, error)

Marshal will encode v to an array of bytes, eventually returning an error.

func Unmarshal

func Unmarshal(b []byte, v interface{}) (err error)

Unmarshal decodes data from the byte array b into the interface v, eventually returning an error.

Types

type Decoder

type Decoder struct {
	// contains filtered or unexported fields
}

Decoder decodes reading reading from an underlying io.Reader

func NewDecoder

func NewDecoder(r io.Reader) *Decoder

NewDecoder returns a Decoder with r as the underlying io.Reader

func (*Decoder) Decode

func (d *Decoder) Decode(v interface{}) (err error)

Decode decodes the data from the reader d.r into the interface v, eventually returning an error

type Encoder

type Encoder struct {
	// contains filtered or unexported fields
}

Encoder handles nbt encoding.

func NewEncoder

func NewEncoder(w io.Writer) *Encoder

NewEncoder returns an Encoder which will write the result of the encoding to w.

func (*Encoder) Encode

func (e *Encoder) Encode(v interface{}) error

Encode will encode v to the writer w specified in the constructor.