vamp

package module

Go to main page

Versions in this module

v0

v0.6.0

Aug 22, 2022

Changes in this version

+ func ValidName(s string) int

+ type Path struct

+ func NewPath(t Type, p ...uint) (res Path, err error)

+ func (p Path) Select(b *ReadBuffer) (rev uint, err error)

type Type

+ func MustNamed(n string, t Type) Type

+ func Parse(rd *bufio.Reader) (typ Type, err error)

v0.5.1

Aug 17, 2022

v0.5.0

Aug 16, 2022

Changes in this version

+ const CheckUTF8

+ const ReadRaw

+ const ReadString

+ var Any anyType

+ var Bool boolType

+ var Float32 float32Type

+ var Float64 float64Type

+ var IOBytesMode = CheckUTF8

+ var Int16 int16Type

+ var Int32 int32Type

+ var Int64 int64Type

+ var Int8 int8Type

+ var Uint16 uint16Type

+ var Uint32 uint32Type

+ var Uint64 uint64Type

+ var Uint8 uint8Type

+ type Array struct

+ func NewArray(length sizeRange, elem Type) *Array

+ func NewOptional(elem Type) *Array

+ func (a *Array) Equals(t Type, names bool) bool

+ func (a *Array) Hash(h hash.Hash, names bool)

+ func (t *Array) DynNo() uint

+ func (t *Array) Elem() Type

+ func (t *Array) FixSize() uint

+ func (t *Array) Index(buf *ReadBuffer, i uint) (revert uint)

+ func (t *Array) Len(buf *ReadBuffer) uint

+ func (t *Array) LenRange() sizeRange

+ func (t *Array) Read(buf *ReadBuffer, into any) error

+ func (t *Array) ReadArray(buf *ReadBuffer, ls ArrayUnmarshaler) error

+ func (t *Array) ReadOpt(buf *ReadBuffer, into any) (ok bool, err error)

+ func (t *Array) String() string

+ func (t *Array) VampRecordRead(rt *Record, buf *ReadBuffer) error

+ func (t *Array) VampRecordWrite(rt *Record, buf *Buffer) error

+ func (t *Array) VampUnionAlt() (uint, any)

+ func (t *Array) Write(buf *Buffer, ls any) (err error)

+ func (t *Array) WriteArray(buf *Buffer, ls ArrayMarshaler) error

+ func (t *Array) WriteOptNone(buf *Buffer) error

+ func (t *Array) WriteOptOne(buf *Buffer, value any) error

+ type Bytes struct

+ func NewBytes(size sizeRange, mode bytesMode) Bytes

+ func NewString(size sizeRange) Bytes

+ func (s Bytes) Equals(t Type, _ bool) bool

+ func (s Bytes) Hash(h hash.Hash, _ bool)

+ func (t *Bytes) VampFromUint8(v uint8) error

+ func (t Bytes) DynNo() uint

+ func (t Bytes) FixSize() uint

+ func (t Bytes) LenRange() sizeRange

+ func (t Bytes) Read(buf *ReadBuffer, into any) (err error)

+ func (t Bytes) ReadBytes(buf *ReadBuffer) []byte

+ func (t Bytes) ReadString(buf *ReadBuffer) string

+ func (t Bytes) String() string

+ func (t Bytes) VampToUint8() (uint8, error)

+ func (t Bytes) VampUnionAlt() (uint, any)

+ func (t Bytes) Write(buf *Buffer, value any) error

+ func (t Bytes) WriteBytes(buf *Buffer, data []byte) error

+ func (t Bytes) WriteString(buf *Buffer, s string) error

+ type List struct

+ func NewList(length sizeRange, elem Type) *List

+ func (a *List) Hash(h hash.Hash, names bool)

+ func (l *List) Equals(t Type, names bool) bool

+ func (l *List) ReadStream(r io.Reader, offSize sizeRange, buffer []byte) *ReadStream

+ func (l *List) WriteStream(w io.Writer, offSize sizeRange, buffer []byte) *WriteStream

+ func (t *List) DynNo() uint

+ func (t *List) Elem() Type

+ func (t *List) FixSize() uint

+ func (t *List) LenRange() sizeRange

+ func (t *List) ListLen(buf *ReadBuffer) (len uint, ok bool)

+ func (t *List) Next(buf *ReadBuffer) (revert uint, ok bool)

+ func (t *List) Read(buf *ReadBuffer, into any) error

+ func (t *List) ReadList(buf *ReadBuffer, into ListUnmarshaler) error

+ func (t *List) String() string

+ func (t *List) VampRecordRead(rt *Record, buf *ReadBuffer) error

+ func (t *List) VampRecordWrite(rt *Record, buf *Buffer) error

+ func (t *List) VampUnionAlt() (uint, any)

+ func (t *List) Write(buf *Buffer, val any) error

+ func (t *List) WriteList(buf *Buffer, ls ListMarshaler) error

+ type ReadStream struct

+ func (rs *ReadStream) Buffer() *ReadBuffer

+ func (rs *ReadStream) Err() error

+ func (rs *ReadStream) Head() (length uint, data []byte, error error)

+ func (rs *ReadStream) Next() bool

+ func (rs *ReadStream) Read(into any) error

+ type Record struct

+ func NewRecord(fields ...Type) *Record

+ func (r *Record) Equals(t Type, names bool) bool

+ func (r *Record) Hash(h hash.Hash, names bool)

+ func (t *Record) DynNo() uint

+ func (t *Record) Field(buf *ReadBuffer, i uint) (revert uint)

+ func (t *Record) FieldName(i uint) string

+ func (t *Record) FieldType(i uint) Type

+ func (t *Record) FixSize() uint

+ func (t *Record) NumField() uint

+ func (t *Record) Read(buf *ReadBuffer, out any) (err error)

+ func (t *Record) ReadFields(buf *ReadBuffer, outs ...any) error

+ func (t *Record) String() string

+ func (t *Record) VampArrayFinish() error

+ func (t *Record) VampArrayLen() uint

+ func (t *Record) VampArrayReader(i uint) (any, error)

+ func (t *Record) VampArrayResize(l uint) error

+ func (t *Record) VampArrayWriter(i uint) (any, error)

+ func (t *Record) VampUnionAlt() (uint, any)

+ func (t *Record) Write(buf *Buffer, values any) error

+ func (t *Record) WriteFields(buf *Buffer, values ...any) error

+ type Union struct

+ AltReader func(alt uint, into any) (reader any, err error)

+ func NewUnion(altRange sizeRange, alts ...Type) *Union

+ func (t *Union) Alt(i uint) Type

+ func (t *Union) AltName(i uint) string

+ func (t *Union) AltRange() sizeRange

+ func (t *Union) DynNo() uint

+ func (t *Union) FixSize() uint

+ func (t *Union) NumAlts() uint

+ func (t *Union) Read(buf *ReadBuffer, into any) error

+ func (t *Union) ReadAlt(buf *ReadBuffer, selectVal func(uint) any) (any, error)

+ func (t *Union) String() string

+ func (t *Union) VampRecordRead(rt *Record, buf *ReadBuffer) error

+ func (t *Union) VampRecordWrite(rt *Record, buf *Buffer) error

+ func (t *Union) VampUnionAlt() (uint, any)

+ func (t *Union) WithAltReader(f func(uint, any) (any, error)) *Union

+ func (t *Union) Write(buf *Buffer, value any) error

+ func (t *Union) WriteAlt(buf *Buffer, alt uint, value any) error

+ func (u *Union) Equals(t Type, names bool) bool

+ func (u *Union) Hash(h hash.Hash, names bool)

+ type WriteStream struct

+ func (ws *WriteStream) Close() error

+ func (ws *WriteStream) Flush() error

+ func (ws *WriteStream) Write(elem any) error

+ func (ws *WriteStream) WriteLast(elem any) error

+ func (ws *WriteStream) WriteWithNext(elem any) error

v0.4.0

Aug 13, 2022

Changes in this version

+ func Named(n string, t Type) namedType

+ func TypeName(t Type) string

type Reflect

+ func (r Reflect) MustTypeOf(val any) Type

type Type

+ func Anonymize(t Type) Type

+ func MustTypeOf(val any) Type

type UnionType

+ func (t *UnionType) AltName(i uint) string

v0.3.0

Aug 11, 2022

v0.2.0

Aug 10, 2022

Changes in this version

+ type PathElement struct

+ Idx uint

+ T Type

+ type PathError struct

+ func (e PathError) Error() string

+ func (e PathError) Unwrap() error

v0.1.0

Aug 6, 2022

Changes in this version

+ const HeaderSize

+ const Version

+ var AnyType anyType

+ var BoolType boolType

+ var Float32Type float32Type

+ var Float64Type float64Type

+ var Int16Type int16Type

+ var Int32Type int32Type

+ var Int64Type int64Type

+ var Int8Type int8Type

+ var Uint16Type uint16Type

+ var Uint32Type uint32Type

+ var Uint64Type uint64Type

+ var Uint8Type uint8Type

+ func ResetTypeBuffer(buf *Buffer, off SizeRange, prefix int)

+ func WriteType(buf *Buffer, t Type) error

+ type Alt struct

+ S uint

+ V any

+ func (a Alt) VampUnionAlt() (uint, any)

+ type AnyMarshaler interface

+ VampAnyType func() (Type, any)

+ type ArrayMarshaler interface

+ VampArrayLen func() uint

+ VampArrayWriter func(i uint) (any, error)

+ type ArrayType struct

+ func NewArrayType(length SizeRange, elem Type) (*ArrayType, error)

+ func NewOptionalType(elem Type) *ArrayType

+ func (a *ArrayType) Equals(t Type) bool

+ func (a *ArrayType) Hash(h hash.Hash)

+ func (t *ArrayType) DynNo() uint

+ func (t *ArrayType) Elem() Type

+ func (t *ArrayType) FixSize() uint

+ func (t *ArrayType) Index(buf *ReadBuffer, i uint) (revert uint)

+ func (t *ArrayType) Len(buf *ReadBuffer) uint

+ func (t *ArrayType) LenRange() SizeRange

+ func (t *ArrayType) Read(buf *ReadBuffer, into any) error

+ func (t *ArrayType) ReadArray(buf *ReadBuffer, ls ArrayUnmarshaler) error

+ func (t *ArrayType) ReadOpt(buf *ReadBuffer, into any) (ok bool, err error)

+ func (t *ArrayType) String() string

+ func (t *ArrayType) VampRecordRead(rt *RecordType, buf *ReadBuffer) error

+ func (t *ArrayType) VampRecordWrite(rt *RecordType, buf *Buffer) error

+ func (t *ArrayType) VampUnionAlt() (uint, any)

+ func (t *ArrayType) Write(buf *Buffer, ls any) (err error)

+ func (t *ArrayType) WriteArray(buf *Buffer, ls ArrayMarshaler) error

+ func (t *ArrayType) WriteOptNone(buf *Buffer) error

+ func (t *ArrayType) WriteOptOne(buf *Buffer, value any) error

+ type ArrayUnmarshaler interface

+ VampArrayFinish func() error

+ VampArrayReader func(i uint) (any, error)

+ VampArrayResize func(l uint) error

+ type Buffer struct

+ func NewTypeWriteBuffer(off SizeRange, at int, buf []byte) (*Buffer, error)

+ func NewWriteBuffer(t Type, off SizeRange, at int, buf []byte) (*Buffer, error)

+ func (b *Buffer) Reset(t Type, off SizeRange, prefix int) error

+ type BytesMode uint8

+ const BytesRaw

+ const BytesString

+ const BytesUTF8

+ type BytesType struct

+ func NewBytesType(size SizeRange) (BytesType, error)

+ func NewBytesTypeMode(size SizeRange, mode BytesMode) (BytesType, error)

+ func (s BytesType) Equals(t Type) bool

+ func (s BytesType) Hash(h hash.Hash)

+ func (t *BytesType) VampFromUint8(v uint8) error

+ func (t BytesType) DynNo() uint

+ func (t BytesType) FixSize() uint

+ func (t BytesType) LenRange() SizeRange

+ func (t BytesType) Read(buf *ReadBuffer, into any) (err error)

+ func (t BytesType) ReadBytes(buf *ReadBuffer) []byte

+ func (t BytesType) ReadString(buf *ReadBuffer) string

+ func (t BytesType) String() string

+ func (t BytesType) VampToUint8() (uint8, error)

+ func (t BytesType) VampUnionAlt() (uint, any)

+ func (t BytesType) Write(buf *Buffer, value any) error

+ func (t BytesType) WriteBytes(buf *Buffer, data []byte) error

+ func (t BytesType) WriteString(buf *Buffer, s string) error

+ type Header [4]byte

+ func HeaderFor(s SizeRange) Header

+ func ParseHeader(mem []byte) (h Header, pos int)

+ func (h Header) Bytes() []byte

+ func (h Header) SizeRange() SizeRange

+ func (h Header) String() string

+ func (h Header) Version() int

+ type ListIterator interface

+ VampListGet func() any

+ VampListNext func() bool

+ type ListMarshaler interface

+ VampListIter func() ListIterator

+ type ListType struct

+ func NewListType(length SizeRange, elem Type) (*ListType, error)

+ func (a *ListType) Hash(h hash.Hash)

+ func (l *ListType) Equals(t Type) bool

+ func (t *ListType) DynNo() uint

+ func (t *ListType) Elem() Type

+ func (t *ListType) FixSize() uint

+ func (t *ListType) LenRange() SizeRange

+ func (t *ListType) ListLen(buf *ReadBuffer) (len uint, ok bool)

+ func (t *ListType) Next(buf *ReadBuffer) (revert uint, ok bool)

+ func (t *ListType) Read(buf *ReadBuffer, into any) error

+ func (t *ListType) ReadList(buf *ReadBuffer, into ListUnmarshaler) error

+ func (t *ListType) String() string

+ func (t *ListType) VampRecordRead(rt *RecordType, buf *ReadBuffer) error

+ func (t *ListType) VampRecordWrite(rt *RecordType, buf *Buffer) error

+ func (t *ListType) VampUnionAlt() (uint, any)

+ func (t *ListType) Write(buf *Buffer, val any) error

+ func (t *ListType) WriteList(buf *Buffer, ls ListMarshaler) error

+ type ListUnmarshaler interface

+ VampListAppend func(any) error

+ VampListReader func() (any, error)

+ type ReadBuffer struct

+ func NewReadBuffer(t Type, buf []byte, search bool) (*ReadBuffer, error)

+ func NewReadBufferOffSize(t Type, off SizeRange, buf []byte) (*ReadBuffer, error)

+ func NewTypeReadBuffer(buf []byte, search bool) (*ReadBuffer, error)

+ func NewTypeReadBufferOffSize(off SizeRange, buf []byte) (*ReadBuffer, error)

+ func (b *ReadBuffer) AllBytes() []byte

+ func (b *ReadBuffer) Bytes() []byte

+ func (b *ReadBuffer) Offset() SizeRange

+ func (b *ReadBuffer) SliceFix(off uint) (revert uint)

+ func (b *ReadBuffer) Unslice(revert uint)

+ type RecordMarshaler interface

+ VampRecordWrite func(*RecordType, *Buffer) error

+ type RecordType struct

+ func NewRecordType(fields ...Type) (*RecordType, error)

+ func (r *RecordType) Equals(t Type) bool

+ func (r *RecordType) Hash(h hash.Hash)

+ func (t *RecordType) DynNo() uint

+ func (t *RecordType) Field(buf *ReadBuffer, i uint) (revert uint)

+ func (t *RecordType) FieldName(i uint) string

+ func (t *RecordType) FieldType(i uint) Type

+ func (t *RecordType) FixSize() uint

+ func (t *RecordType) NumField() uint

+ func (t *RecordType) Read(buf *ReadBuffer, out any) (err error)

+ func (t *RecordType) ReadFields(buf *ReadBuffer, outs ...any) error

+ func (t *RecordType) SetNames(ns ...string) *RecordType

+ func (t *RecordType) String() string

+ func (t *RecordType) VampArrayFinish() error

+ func (t *RecordType) VampArrayLen() uint

+ func (t *RecordType) VampArrayReader(i uint) (any, error)

+ func (t *RecordType) VampArrayResize(l uint) error

+ func (t *RecordType) VampArrayWriter(i uint) (any, error)

+ func (t *RecordType) VampUnionAlt() (uint, any)

+ func (t *RecordType) Write(buf *Buffer, values any) error

+ func (t *RecordType) WriteFields(buf *Buffer, values ...any) error

+ type RecordUnmarshaler interface

+ VampRecordRead func(*RecordType, *ReadBuffer) error

+ type Reflect struct

+ func DefaultReflect() Reflect

+ func (r Reflect) ArraySize(s SizeRange) (res Reflect)

+ func (r Reflect) StringSize(s SizeRange) (res Reflect)

+ func (r Reflect) TypeOf(val any) (Type, error)

+ type SizeRange uint8

+ const Size16

+ const Size32

+ const Size8

+ func (i SizeRange) String() string

+ func (s *SizeRange) VampFromUint8(i uint8) error

+ func (s SizeRange) Check(size uint) error

+ func (s SizeRange) Max() uint

+ func (s SizeRange) Size() uint

+ func (s SizeRange) Valid() bool

+ func (s SizeRange) VampToUint8() (uint8, error)

+ type Type interface

+ DynNo func() uint

+ Equals func(t Type) bool

+ FixSize func() uint

+ Hash func(hash.Hash)

+ Read func(b *ReadBuffer, into any) error

+ Write func(b *Buffer, value any) error

+ func ReadType(buf *ReadBuffer) (t Type, err error)

+ func TypeOf(val any) (Type, error)

+ type UnionMarshaler interface

+ VampUnionAlt func() (uint, any)

+ type UnionType struct

+ AltReader func(alt uint, into any) (reader any, err error)

+ func NewUnionType(altRange SizeRange, alts ...Type) (*UnionType, error)

+ func (t *UnionType) Alt(i uint) Type

+ func (t *UnionType) AltRange() SizeRange

+ func (t *UnionType) DynNo() uint

+ func (t *UnionType) FixSize() uint

+ func (t *UnionType) NumAlts() uint

+ func (t *UnionType) Read(buf *ReadBuffer, into any) error

+ func (t *UnionType) ReadAlt(buf *ReadBuffer, selectVal func(uint) any) (any, error)

+ func (t *UnionType) String() string

+ func (t *UnionType) VampRecordRead(rt *RecordType, buf *ReadBuffer) error

+ func (t *UnionType) VampRecordWrite(rt *RecordType, buf *Buffer) error

+ func (t *UnionType) VampUnionAlt() (uint, any)

+ func (t *UnionType) WithAltReader(f func(uint, any) (any, error)) *UnionType

+ func (t *UnionType) Write(buf *Buffer, value any) error

+ func (t *UnionType) WriteAlt(buf *Buffer, alt uint, value any) error

+ func (u *UnionType) Equals(t Type) bool

+ func (u *UnionType) Hash(h hash.Hash)

+ type UnionUnmarshaler interface

+ VampUnionReader func(alt uint, into any) (any, error)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL