serialization

Documentation

Index

• Variables
• func GetVarUintSize(value uint64) int
• func ReadBool(reader io.Reader) (bool, error)
• func ReadByte(reader io.Reader) (byte, error)
• func ReadBytes(reader io.Reader, length uint64) ([]byte, error)
• func ReadUint16(reader io.Reader) (uint16, error)
• func ReadUint32(reader io.Reader) (uint32, error)
• func ReadUint64(reader io.Reader) (uint64, error)
• func ReadUint8(reader io.Reader) (uint8, error)
• func ReadVarBytes(reader io.Reader) ([]byte, error)
• func ReadVarString(reader io.Reader) (string, error)
• func ReadVarUint(reader io.Reader, maxint uint64) (uint64, error)
• func ToArray(data SerializableData) []byte
• func WriteBool(writer io.Writer, val bool) error
• func WriteByte(writer io.Writer, val byte) error
• func WriteUint16(writer io.Writer, val uint16) error
• func WriteUint32(writer io.Writer, val uint32) error
• func WriteUint64(writer io.Writer, val uint64) error
• func WriteUint8(writer io.Writer, val uint8) error
• func WriteVarBytes(writer io.Writer, value []byte) error
• func WriteVarString(writer io.Writer, value string) error
• func WriteVarUint(writer io.Writer, value uint64) error
• type SerializableData

Variables

var ErrEof = errors.New("got EOF, can not get the next byte")

var ErrRange = errors.New("value out of range")

Functions

func GetVarUintSize

func GetVarUintSize(value uint64) int

func ReadBool

func ReadBool(reader io.Reader) (bool, error)

func ReadByte

func ReadByte(reader io.Reader) (byte, error)

func ReadBytes

func ReadBytes(reader io.Reader, length uint64) ([]byte, error)

func ReadUint16

func ReadUint16(reader io.Reader) (uint16, error)

func ReadUint32

func ReadUint32(reader io.Reader) (uint32, error)

func ReadUint64

func ReadUint64(reader io.Reader) (uint64, error)

func ReadUint8

func ReadUint8(reader io.Reader) (uint8, error)

func ReadVarBytes

func ReadVarBytes(reader io.Reader) ([]byte, error)

func ReadVarString

func ReadVarString(reader io.Reader) (string, error)

func ReadVarUint

func ReadVarUint(reader io.Reader, maxint uint64) (uint64, error)

func ToArray

func ToArray(data SerializableData) []byte

func WriteBool

func WriteBool(writer io.Writer, val bool) error

func WriteByte

func WriteByte(writer io.Writer, val byte) error

func WriteUint16

func WriteUint16(writer io.Writer, val uint16) error

func WriteUint32

func WriteUint32(writer io.Writer, val uint32) error

func WriteUint64

func WriteUint64(writer io.Writer, val uint64) error

func WriteUint8

func WriteUint8(writer io.Writer, val uint8) error

func WriteVarBytes

func WriteVarBytes(writer io.Writer, value []byte) error

func WriteVarString

func WriteVarString(writer io.Writer, value string) error

func WriteVarUint

func WriteVarUint(writer io.Writer, value uint64) error

Types

type SerializableData

type SerializableData interface {
	// Write data to writer
	Serialize(w io.Writer) error

	// read data to reader
	Deserialize(r io.Reader) error
}

SerializableData describe the data need be serialized.