y3.go

package y3

import (
	"errors"
	"io"
)

var (
	errBuildIncomplete = errors.New("y3.Encoder: invalid structure of packet")
	errInvalidAdding   = errors.New("y3.Encoder: can not add this Packet after StreamPacket has been add")
	errNonStreamPacket = errors.New("y3.Packet: this packet is not in node mode")
	errWriteFromReader = errors.New("y3.streamV: write from reader error")
	errNotNodeMode     = errors.New("y3.Encoder: packet should be in node mode can be add other packets as child")
	errNilReader       = errors.New("y3.Decoder: nil source reader")
)

// Packet decribe a y3 codec packet
type Packet interface {
	// SeqID returns the sequence ID of this packet.
	SeqID() int
	// Size returns the size of whole packet.
	Size() int
	// VSize returns the size of V.
	VSize() int
	// Bytes returns the whole bytes of this packet.
	Bytes() []byte
	// Reader returns an io.Reader which returns whole bytes.
	Reader() io.Reader
	// GetValReader returns an io.Reader which holds V.
	VReader() io.Reader
	// IsStreamMode returns a bool value indicates if the V of
	// this packet is in stream mode
	IsStreamMode() bool
	// IsNodeMode returns a bool value indicates if this packet
	// is node mode
	IsNodeMode() bool

	// BytesV return V as bytes
	BytesV() []byte
	// StringV return V as utf-8 string
	UTF8StringV() string
	// Int32V return V as int32
	Int32V() (val int32, err error)
	// UInt32V return V as uint32
	UInt32V() (val uint32, err error)
	// Int64V return V as int64
	Int64V() (val int64, err error)
	// UInt64V return V as uint64
	UInt64V() (val uint64, err error)
	// Float32V return V as float32
	Float32V() (val float32, err error)
	// Float64V return V as float64
	Float64V() (val float64, err error)
	// BoolV return V as bool
	BoolV() (val bool, err error)
}