msgp

package

Go to main page

Versions in this module

v1

v1.6.2

Dec 30, 2025

Changes in this version

type Reader

+ func (m *Reader) ReadBytesLimit(scratch []byte, n int64) (b []byte, err error)

v1.6.1

Dec 4, 2025

v1.6.0

Dec 4, 2025

Changes in this version

+ const BinaryAppenderSize

+ const BinaryMarshalerSize

+ const TextAppenderBinSize

+ const TextAppenderStringSize

+ const TextMarshalerBinSize

+ const TextMarshalerStringSize

+ func AppendBytesStringTwoPrefixed(b []byte, sz int) []byte

+ func AppendBytesTwoPrefixed(b []byte, sz int) []byte

type Reader

+ func (m *Reader) ReadBinaryUnmarshal(dst encoding.BinaryUnmarshaler) (err error)

+ func (m *Reader) ReadTextUnmarshal(dst encoding.TextUnmarshaler) (err error)

+ func (m *Reader) ReadTextUnmarshalString(dst encoding.TextUnmarshaler) (err error)

type Writer

+ func (mw *Writer) WriteBinaryAppender(b encoding.BinaryAppender) (err error)

+ func (mw *Writer) WriteTextAppender(b encoding.TextAppender) (err error)

+ func (mw *Writer) WriteTextAppenderString(b encoding.TextAppender) (err error)

v1.5.0

Oct 27, 2025

Changes in this version

+ func AppendArray[T any](b []byte, a []T, writeFn func(b []byte, v T) []byte) []byte

+ func AppendMapSorted[K cmp.Ordered, V any](b []byte, m map[K]V, writeK func(b []byte, k K) []byte, ...) []byte

+ func AppendMap[K comparable, V any](b []byte, m map[K]V, writeK func(b []byte, k K) []byte, ...) []byte

+ func DecoderFromBytes[T any, PT UnmarshalPtr[T]](_ T) func([]byte) (T, []byte, error)

+ func DecoderFrom[T any, PT DecodePtr[T]](r *Reader, _ T) func() (T, error)

+ func EncoderToBytes[T any, _ FlexibleMarshaler[T]](_ T) func([]byte, T) []byte

+ func EncoderTo[T any, _ FlexibleEncoder[T]](w *Writer, _ T) func(T) error

+ func ReadArrayBytes[T any](b []byte, readFn func([]byte) (T, []byte, error)) (iter.Seq[T], func() (remain []byte, err error))

+ func ReadArray[T any](m *Reader, readFn func() (T, error)) iter.Seq2[T, error]

+ func ReadMapBytes[K any, V any](b []byte, readK func([]byte) (K, []byte, error), ...) (iter.Seq2[K, V], func() (remain []byte, err error))

+ func ReadMap[K, V any](m *Reader, readKey func() (K, error), readVal func() (V, error)) (iter.Seq2[K, V], func() error)

+ func WriteArray[T any](w *Writer, a []T, writeFn func(T) error) error

+ func WriteMapSorted[K cmp.Ordered, V any](w *Writer, m map[K]V, writeKey func(K) error, writeVal func(V) error) error

+ func WriteMap[K comparable, V any](w *Writer, m map[K]V, writeKey func(K) error, writeVal func(V) error) error

+ type DecodePtr interface

+ type FlexibleEncoder interface

+ type FlexibleMarshaler interface

type Number

+ func (n *Number) CoerceFloat() float64

+ func (n *Number) CoerceInt() (int64, bool)

+ func (n *Number) CoerceUInt() (uint64, bool)

+ type PtrTo interface

+ type RT interface

+ type RTFor interface

+ type UnmarshalPtr interface

v1.4.0

Aug 22, 2025

Changes in this version

+ var ErrLimitExceeded error = errLimitExceeded

+ type AutoShim struct

+ func (a AutoShim) BoolString(v bool) string

+ func (a AutoShim) ByteString(v byte) string

+ func (a AutoShim) Float32String(v float32) string

+ func (a AutoShim) Float64String(v float64) string

+ func (a AutoShim) Int16String(v int16) string

+ func (a AutoShim) Int32String(v int32) string

+ func (a AutoShim) Int64String(v int64) string

+ func (a AutoShim) Int8String(v int8) string

+ func (a AutoShim) IntString(v int) string

+ func (a AutoShim) ParseBool(s string) (bool, error)

+ func (a AutoShim) ParseByte(s string) (byte, error)

+ func (a AutoShim) ParseFloat32(s string) (float32, error)

+ func (a AutoShim) ParseFloat64(s string) (float64, error)

+ func (a AutoShim) ParseInt(s string) (int, error)

+ func (a AutoShim) ParseInt16(s string) (int16, error)

+ func (a AutoShim) ParseInt32(s string) (int32, error)

+ func (a AutoShim) ParseInt64(s string) (int64, error)

+ func (a AutoShim) ParseInt8(s string) (int8, error)

+ func (a AutoShim) ParseUint(s string) (uint, error)

+ func (a AutoShim) ParseUint16(s string) (uint16, error)

+ func (a AutoShim) ParseUint32(s string) (uint32, error)

+ func (a AutoShim) ParseUint64(s string) (uint64, error)

+ func (a AutoShim) ParseUint8(s string) (uint8, error)

+ func (a AutoShim) Uint16String(v uint16) string

+ func (a AutoShim) Uint32String(v uint32) string

+ func (a AutoShim) Uint64String(v uint64) string

+ func (a AutoShim) Uint8String(v uint8) string

+ func (a AutoShim) UintString(v uint) string

type Reader

+ func (m *Reader) GetMaxElements() uint32

+ func (m *Reader) GetMaxRecursionDepth() int

+ func (m *Reader) GetMaxStringLength() uint64

+ func (m *Reader) SetMaxElements(d uint32)

+ func (m *Reader) SetMaxRecursionDepth(d int)

+ func (m *Reader) SetMaxStringLength(d uint64)

v1.3.0

May 13, 2025

Changes in this version

+ func ReadTimeUTCBytes(b []byte) (t time.Time, o []byte, err error)

type Reader

+ func (m *Reader) ReadTimeUTC() (t time.Time, err error)

v1.2.5

Dec 9, 2024

v1.2.4

Oct 30, 2024

Changes in this version

+ const MsgTimeExtension

+ func AppendTimeExt(b []byte, t time.Time) []byte

+ type InvalidTimestamp struct

+ FieldLength int

+ Nanos int64

+ func (u InvalidTimestamp) Error() (str string)

+ func (u InvalidTimestamp) Resumable() bool

type Writer

+ func (mw *Writer) WriteTimeExt(t time.Time) error

v1.2.3

Oct 22, 2024

v1.2.2

Oct 1, 2024

Changes in this version

+ const JSONNumberSize

+ func AppendFloat(b []byte, f float64) []byte

+ func AppendJSONNumber(b []byte, n json.Number) ([]byte, error)

+ func ReadJSONNumberBytes(b []byte) (number json.Number, o []byte, err error)

type Reader

+ func (m *Reader) ReadJSONNumber() (n json.Number, err error)

type Type

+ const NumberType

type Writer

+ func (mw *Writer) WriteFloat(f float64) error

+ func (mw *Writer) WriteJSONNumber(n json.Number) error

v1.2.1

Sep 6, 2024

Changes in this version

+ var ErrRecursion error = errRecursion

v1.2.0

Jul 2, 2024

v1.1.9

Oct 27, 2023

Changes in this version

type Reader

+ func (m *Reader) ReadExtensionRaw() (int8, []byte, error)

type Writer

+ func (mw *Writer) WriteExtensionRaw(extType int8, payload []byte) error

v1.1.8

Dec 31, 2022

v1.1.7

Dec 11, 2022

Changes in this version

+ const DurationSize

+ func AppendDuration(b []byte, d time.Duration) []byte

+ func ReadDurationBytes(b []byte) (d time.Duration, o []byte, err error)

type Reader

+ func (m *Reader) ReadDuration() (d time.Duration, err error)

type Type

+ const DurationType

type Writer

+ func (mw *Writer) WriteDuration(d time.Duration) error

v1.1.6

May 26, 2021

Changes in this version

+ func AppendBytesHeader(b []byte, sz uint32) []byte

+ func ReadBytesHeader(b []byte) (sz uint32, o []byte, err error)

v1.1.5

Nov 25, 2020

v1.1.4

Nov 11, 2020

v1.1.3

Oct 21, 2020

Changes in this version

type Reader

+ func NewReaderBuf(r io.Reader, buf []byte) *Reader

type Writer

+ func NewWriterBuf(w io.Writer, buf []byte) *Writer

v1.1.2

Mar 5, 2020

v1.1.1

Oct 14, 2019

v1.1.0

Nov 28, 2018

Changes in this version

+ func Cause(e error) error

+ func Resumable(e error) bool

+ func WrapError(err error, ctx ...interface{}) error

+ type UintBelowZero struct

+ Value int64

+ func (u UintBelowZero) Error() string

+ func (u UintBelowZero) Resumable() bool

v1.0.2

Jun 27, 2017

v1.0.1

May 10, 2017

Changes in this version

+ const ArrayHeaderSize

+ const BoolSize

+ const ByteSize

+ const BytesPrefixSize

+ const Complex128Extension

+ const Complex128Size

+ const Complex64Extension

+ const Complex64Size

+ const ExtensionPrefixSize

+ const Float32Size

+ const Float64Size

+ const Int16Size

+ const Int32Size

+ const Int64Size

+ const Int8Size

+ const IntSize

+ const MapHeaderSize

+ const NilSize

+ const StringPrefixSize

+ const TimeExtension

+ const TimeSize

+ const Uint16Size

+ const Uint32Size

+ const Uint64Size

+ const Uint8Size

+ const UintSize

+ var ErrShortBytes error = errShort

+ var Nowhere io.Writer = nwhere

+ func AppendArrayHeader(b []byte, sz uint32) []byte

+ func AppendBool(b []byte, t bool) []byte

+ func AppendByte(b []byte, u byte) []byte

+ func AppendBytes(b []byte, bts []byte) []byte

+ func AppendComplex128(b []byte, c complex128) []byte

+ func AppendComplex64(b []byte, c complex64) []byte

+ func AppendExtension(b []byte, e Extension) ([]byte, error)

+ func AppendFloat32(b []byte, f float32) []byte

+ func AppendFloat64(b []byte, f float64) []byte

+ func AppendInt(b []byte, i int) []byte

+ func AppendInt16(b []byte, i int16) []byte

+ func AppendInt32(b []byte, i int32) []byte

+ func AppendInt64(b []byte, i int64) []byte

+ func AppendInt8(b []byte, i int8) []byte

+ func AppendIntf(b []byte, i interface{}) ([]byte, error)

+ func AppendMapHeader(b []byte, sz uint32) []byte

+ func AppendMapStrIntf(b []byte, m map[string]interface{}) ([]byte, error)

+ func AppendMapStrStr(b []byte, m map[string]string) []byte

+ func AppendNil(b []byte) []byte

+ func AppendString(b []byte, s string) []byte

+ func AppendStringFromBytes(b []byte, str []byte) []byte

+ func AppendTime(b []byte, t time.Time) []byte

+ func AppendUint(b []byte, u uint) []byte

+ func AppendUint16(b []byte, u uint16) []byte

+ func AppendUint32(b []byte, u uint32) []byte

+ func AppendUint64(b []byte, u uint64) []byte

+ func AppendUint8(b []byte, u uint8) []byte

+ func CopyReplace(key string, raw []byte, val []byte) []byte

+ func CopyToJSON(dst io.Writer, src io.Reader) (n int64, err error)

+ func Decode(r io.Reader, d Decodable) error

+ func Encode(w io.Writer, e Encodable) error

+ func GuessSize(i interface{}) int

+ func HasKey(key string, raw []byte) bool

+ func IsNil(b []byte) bool

+ func Locate(key string, raw []byte) []byte

+ func ReadArrayHeaderBytes(b []byte) (sz uint32, o []byte, err error)

+ func ReadBoolBytes(b []byte) (bool, []byte, error)

+ func ReadByteBytes(b []byte) (byte, []byte, error)

+ func ReadBytesBytes(b []byte, scratch []byte) (v []byte, o []byte, err error)

+ func ReadBytesZC(b []byte) (v []byte, o []byte, err error)

+ func ReadComplex128Bytes(b []byte) (c complex128, o []byte, err error)

+ func ReadComplex64Bytes(b []byte) (c complex64, o []byte, err error)

+ func ReadExactBytes(b []byte, into []byte) (o []byte, err error)

+ func ReadExtensionBytes(b []byte, e Extension) ([]byte, error)

+ func ReadFile(dst Unmarshaler, file *os.File) error — darwin/amd64, linux/amd64, windows/amd64

+ func ReadFloat32Bytes(b []byte) (f float32, o []byte, err error)

+ func ReadFloat64Bytes(b []byte) (f float64, o []byte, err error)

+ func ReadInt16Bytes(b []byte) (int16, []byte, error)

+ func ReadInt32Bytes(b []byte) (int32, []byte, error)

+ func ReadInt64Bytes(b []byte) (i int64, o []byte, err error)

+ func ReadInt8Bytes(b []byte) (int8, []byte, error)

+ func ReadIntBytes(b []byte) (int, []byte, error)

+ func ReadIntfBytes(b []byte) (i interface{}, o []byte, err error)

+ func ReadMapHeaderBytes(b []byte) (sz uint32, o []byte, err error)

+ func ReadMapKeyZC(b []byte) ([]byte, []byte, error)

+ func ReadMapStrIntfBytes(b []byte, old map[string]interface{}) (v map[string]interface{}, o []byte, err error)

+ func ReadNilBytes(b []byte) ([]byte, error)

+ func ReadStringAsBytes(b []byte, scratch []byte) (v []byte, o []byte, err error)

+ func ReadStringBytes(b []byte) (string, []byte, error)

+ func ReadStringZC(b []byte) (v []byte, o []byte, err error)

+ func ReadTimeBytes(b []byte) (t time.Time, o []byte, err error)

+ func ReadUint16Bytes(b []byte) (uint16, []byte, error)

+ func ReadUint32Bytes(b []byte) (uint32, []byte, error)

+ func ReadUint64Bytes(b []byte) (u uint64, o []byte, err error)

+ func ReadUint8Bytes(b []byte) (uint8, []byte, error)

+ func ReadUintBytes(b []byte) (uint, []byte, error)

+ func RegisterExtension(typ int8, f func() Extension)

+ func Remove(key string, raw []byte) []byte

+ func Replace(key string, raw []byte, val []byte) []byte

+ func Require(old []byte, extra int) []byte

+ func Skip(b []byte) ([]byte, error)

+ func UnmarshalAsJSON(w io.Writer, msg []byte) ([]byte, error)

+ func UnsafeBytes(s string) []byte

+ func UnsafeString(b []byte) string

+ func WriteFile(src MarshalSizer, file *os.File) error — darwin/amd64, linux/amd64, windows/amd64

+ type ArrayError struct

+ Got uint32

+ Wanted uint32

+ func (a ArrayError) Error() string

+ func (a ArrayError) Resumable() bool

+ type Decodable interface

+ DecodeMsg func(*Reader) error

+ type Encodable interface

+ EncodeMsg func(*Writer) error

+ type EndlessReader struct

+ func NewEndlessReader(b []byte, tb timer) *EndlessReader

+ func (c *EndlessReader) Read(p []byte) (int, error)

+ type ErrUnsupportedType struct

+ T reflect.Type

+ func (e *ErrUnsupportedType) Error() string

+ func (e *ErrUnsupportedType) Resumable() bool

+ type Error interface

+ Resumable func() bool

+ type Extension interface

+ ExtensionType func() int8

+ Len func() int

+ MarshalBinaryTo func([]byte) error

+ UnmarshalBinary func([]byte) error

+ type ExtensionTypeError struct

+ Got int8

+ Want int8

+ func (e ExtensionTypeError) Error() string

+ func (e ExtensionTypeError) Resumable() bool

+ type IntOverflow struct

+ FailedBitsize int

+ Value int64

+ func (i IntOverflow) Error() string

+ func (i IntOverflow) Resumable() bool

+ type InvalidPrefixError byte

+ func (i InvalidPrefixError) Error() string

+ func (i InvalidPrefixError) Resumable() bool

+ type MarshalSizer interface — darwin/amd64, linux/amd64, windows/amd64

+ type Marshaler interface

+ MarshalMsg func([]byte) ([]byte, error)

+ type Number struct

+ func (n *Number) AsFloat32(f float32)

+ func (n *Number) AsFloat64(f float64)

+ func (n *Number) AsInt(i int64)

+ func (n *Number) AsUint(u uint64)

+ func (n *Number) DecodeMsg(r *Reader) error

+ func (n *Number) EncodeMsg(w *Writer) error

+ func (n *Number) Float() (float64, bool)

+ func (n *Number) Int() (int64, bool)

+ func (n *Number) MarshalJSON() ([]byte, error)

+ func (n *Number) MarshalMsg(b []byte) ([]byte, error)

+ func (n *Number) Msgsize() int

+ func (n *Number) String() string

+ func (n *Number) Type() Type

+ func (n *Number) Uint() (uint64, bool)

+ func (n *Number) UnmarshalMsg(b []byte) ([]byte, error)

+ type Raw []byte

+ func (r *Raw) DecodeMsg(f *Reader) error

+ func (r *Raw) MarshalJSON() ([]byte, error)

+ func (r *Raw) UnmarshalMsg(b []byte) ([]byte, error)

+ func (r Raw) EncodeMsg(w *Writer) error

+ func (r Raw) MarshalMsg(b []byte) ([]byte, error)

+ func (r Raw) Msgsize() int

+ type RawExtension struct

+ Data []byte

+ Type int8

+ func (r *RawExtension) ExtensionType() int8

+ func (r *RawExtension) Len() int

+ func (r *RawExtension) MarshalBinaryTo(d []byte) error

+ func (r *RawExtension) UnmarshalBinary(b []byte) error

+ type Reader struct

+ R *fwd.Reader

+ func NewReader(r io.Reader) *Reader

+ func NewReaderSize(r io.Reader, sz int) *Reader

+ func (m *Reader) BufferSize() int

+ func (m *Reader) Buffered() int

+ func (m *Reader) CopyNext(w io.Writer) (int64, error)

+ func (m *Reader) IsNil() bool

+ func (m *Reader) NextType() (Type, error)

+ func (m *Reader) Read(p []byte) (int, error)

+ func (m *Reader) ReadArrayHeader() (sz uint32, err error)

+ func (m *Reader) ReadBool() (b bool, err error)

+ func (m *Reader) ReadByte() (b byte, err error)

+ func (m *Reader) ReadBytes(scratch []byte) (b []byte, err error)

+ func (m *Reader) ReadBytesHeader() (sz uint32, err error)

+ func (m *Reader) ReadComplex128() (f complex128, err error)

+ func (m *Reader) ReadComplex64() (f complex64, err error)

+ func (m *Reader) ReadExactBytes(into []byte) error

+ func (m *Reader) ReadExtension(e Extension) (err error)

+ func (m *Reader) ReadFloat32() (f float32, err error)

+ func (m *Reader) ReadFloat64() (f float64, err error)

+ func (m *Reader) ReadFull(p []byte) (int, error)

+ func (m *Reader) ReadInt() (i int, err error)

+ func (m *Reader) ReadInt16() (i int16, err error)

+ func (m *Reader) ReadInt32() (i int32, err error)

+ func (m *Reader) ReadInt64() (i int64, err error)

+ func (m *Reader) ReadInt8() (i int8, err error)

+ func (m *Reader) ReadIntf() (i interface{}, err error)

+ func (m *Reader) ReadMapHeader() (sz uint32, err error)

+ func (m *Reader) ReadMapKey(scratch []byte) ([]byte, error)

+ func (m *Reader) ReadMapKeyPtr() ([]byte, error)

+ func (m *Reader) ReadMapStrIntf(mp map[string]interface{}) (err error)

+ func (m *Reader) ReadNil() error

+ func (m *Reader) ReadString() (s string, err error)

+ func (m *Reader) ReadStringAsBytes(scratch []byte) (b []byte, err error)

+ func (m *Reader) ReadStringHeader() (sz uint32, err error)

+ func (m *Reader) ReadTime() (t time.Time, err error)

+ func (m *Reader) ReadUint() (u uint, err error)

+ func (m *Reader) ReadUint16() (u uint16, err error)

+ func (m *Reader) ReadUint32() (u uint32, err error)

+ func (m *Reader) ReadUint64() (u uint64, err error)

+ func (m *Reader) ReadUint8() (u uint8, err error)

+ func (m *Reader) Reset(r io.Reader)

+ func (m *Reader) Skip() error

+ func (r *Reader) WriteToJSON(w io.Writer) (n int64, err error)

+ type Sizer interface

+ Msgsize func() int

+ type Type byte

+ const ArrayType

+ const BinType

+ const BoolType

+ const Complex128Type

+ const Complex64Type

+ const ExtensionType

+ const Float32Type

+ const Float64Type

+ const IntType

+ const InvalidType

+ const MapType

+ const NilType

+ const StrType

+ const TimeType

+ const UintType

+ func NextType(b []byte) Type

+ func (t Type) String() string

+ type TypeError struct

+ Encoded Type

+ Method Type

+ func (t TypeError) Error() string

+ func (t TypeError) Resumable() bool

+ type UintOverflow struct

+ FailedBitsize int

+ Value uint64

+ func (u UintOverflow) Error() string

+ func (u UintOverflow) Resumable() bool

+ type Unmarshaler interface

+ UnmarshalMsg func([]byte) ([]byte, error)

+ type Writer struct

+ func NewWriter(w io.Writer) *Writer

+ func NewWriterSize(w io.Writer, sz int) *Writer

+ func (mw *Writer) Append(b ...byte) error

+ func (mw *Writer) Buffered() int

+ func (mw *Writer) Flush() error

+ func (mw *Writer) Reset(w io.Writer)

+ func (mw *Writer) Write(p []byte) (int, error)

+ func (mw *Writer) WriteArrayHeader(sz uint32) error

+ func (mw *Writer) WriteBool(b bool) error

+ func (mw *Writer) WriteByte(u byte) error

+ func (mw *Writer) WriteBytes(b []byte) error

+ func (mw *Writer) WriteBytesHeader(sz uint32) error

+ func (mw *Writer) WriteComplex128(f complex128) error

+ func (mw *Writer) WriteComplex64(f complex64) error

+ func (mw *Writer) WriteExtension(e Extension) error

+ func (mw *Writer) WriteFloat32(f float32) error

+ func (mw *Writer) WriteFloat64(f float64) error

+ func (mw *Writer) WriteInt(i int) error

+ func (mw *Writer) WriteInt16(i int16) error

+ func (mw *Writer) WriteInt32(i int32) error

+ func (mw *Writer) WriteInt64(i int64) error

+ func (mw *Writer) WriteInt8(i int8) error

+ func (mw *Writer) WriteIntf(v interface{}) error

+ func (mw *Writer) WriteMapHeader(sz uint32) error

+ func (mw *Writer) WriteMapStrIntf(mp map[string]interface{}) (err error)

+ func (mw *Writer) WriteMapStrStr(mp map[string]string) (err error)

+ func (mw *Writer) WriteNil() error

+ func (mw *Writer) WriteString(s string) error

+ func (mw *Writer) WriteStringFromBytes(str []byte) error

+ func (mw *Writer) WriteStringHeader(sz uint32) error

+ func (mw *Writer) WriteTime(t time.Time) error

+ func (mw *Writer) WriteUint(u uint) error

+ func (mw *Writer) WriteUint16(u uint16) error

+ func (mw *Writer) WriteUint32(u uint32) error

+ func (mw *Writer) WriteUint64(u uint64) error

+ func (mw *Writer) WriteUint8(u uint8) error

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