package bare

import "git.sr.ht/~sircmpwn/go-bare"

An implementation of the BARE message format for Go.

https://git.sr.ht/~sircmpwn/bare

See the git repository for usage examples:

https://git.sr.ht/~sircmpwn/go-bare

Index ¶

• Variables
• func Marshal(val interface{}) ([]byte, error)
• func MarshalWriter(w *Writer, val interface{}) error
• func MaxArrayLength(length uint64)
• func MaxMapSize(size uint64)
• func MaxUnmarshalBytes(bytes uint64)
• func Unmarshal(data []byte, val interface{}) error
• func UnmarshalBareReader(r *Reader, val interface{}) error
• func UnmarshalReader(r io.Reader, val interface{}) error
• type Int
• type Marshalable
• type Reader
• func NewReader(base io.Reader) *Reader
• func (r *Reader) ReadBool() (bool, error)
• func (r *Reader) ReadData() ([]byte, error)
• func (r *Reader) ReadDataFixed(dest []byte) error
• func (r *Reader) ReadF32() (float32, error)
• func (r *Reader) ReadF64() (float64, error)
• func (r *Reader) ReadI16() (int16, error)
• func (r *Reader) ReadI32() (int32, error)
• func (r *Reader) ReadI64() (int64, error)
• func (r *Reader) ReadI8() (int8, error)
• func (r *Reader) ReadInt() (int64, error)
• func (r *Reader) ReadString() (string, error)
• func (r *Reader) ReadU16() (uint16, error)
• func (r *Reader) ReadU32() (uint32, error)
• func (r *Reader) ReadU64() (uint64, error)
• func (r *Reader) ReadU8() (uint8, error)
• func (r *Reader) ReadUint() (uint64, error)
• type Uint
• type Union
• type UnionTags
• func RegisterUnion(iface interface{}) *UnionTags
• func (ut *UnionTags) Member(t interface{}, tag uint64) *UnionTags
• func (ut *UnionTags) TagFor(v interface{}) (uint64, bool)
• func (ut *UnionTags) TypeFor(tag uint64) (reflect.Type, bool)
• type Unmarshalable
• type UnsupportedTypeError
• func (e *UnsupportedTypeError) Error() string
• type Writer
• func NewWriter(base io.Writer) *Writer
• func (w *Writer) WriteBool(b bool) error
• func (w *Writer) WriteData(data []byte) error
• func (w *Writer) WriteDataFixed(data []byte) error
• func (w *Writer) WriteF32(f float32) error
• func (w *Writer) WriteF64(f float64) error
• func (w *Writer) WriteI16(i int16) error
• func (w *Writer) WriteI32(i int32) error
• func (w *Writer) WriteI64(i int64) error
• func (w *Writer) WriteI8(i int8) error
• func (w *Writer) WriteInt(i int64) error
• func (w *Writer) WriteString(str string) error
• func (w *Writer) WriteU16(i uint16) error
• func (w *Writer) WriteU32(i uint32) error
• func (w *Writer) WriteU64(i uint64) error
• func (w *Writer) WriteU8(i uint8) error
• func (w *Writer) WriteUint(i uint64) error

Variables ¶

var ErrInvalidStr = errors.New("String contains invalid UTF-8 sequences")

var ErrLimitExceeded = errors.New("Maximum message size exceeded")

Use MaxUnmarshalBytes to prevent this error from occuring on messages which are large by design.

Functions ¶

func Marshal ¶

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

Marshals a value (val, which must be a pointer) into a BARE message.

The encoding of each struct field can be customized by the format string stored under the "bare" key in the struct field's tag.

As a special case, if the field tag is "-", the field is always omitted.

func MarshalWriter ¶

func MarshalWriter(w *Writer, val interface{}) error

Marshals a value (val, which must be a pointer) into a BARE message and writes it to a Writer. See Marshal for details.

func MaxArrayLength ¶

func MaxArrayLength(length uint64)

MaxArrayLength sets maximum number of elements in array. Defaults to 4096 elements

func MaxMapSize ¶

func MaxMapSize(size uint64)

MaxMapSize sets maximum size of map. Defaults to 1024 key/value pairs

func MaxUnmarshalBytes ¶

func MaxUnmarshalBytes(bytes uint64)

MaxUnmarshalBytes sets the maximum size of a message decoded by unmarshal. By default, this is set to 32 MiB.

func Unmarshal ¶

func Unmarshal(data []byte, val interface{}) error

Unmarshals a BARE message into val, which must be a pointer to a value of the message type.

func UnmarshalBareReader ¶

func UnmarshalBareReader(r *Reader, val interface{}) error

func UnmarshalReader ¶

func UnmarshalReader(r io.Reader, val interface{}) error

Unmarshals a BARE message into value (val, which must be a pointer), from a reader. See Unmarshal for details.

Types ¶

type Int ¶

type Int int64

Int is a variable-length encoded signed integer.

type Marshalable ¶

type Marshalable interface {
	Marshal(w *Writer) error
}

A type which implements this interface will be responsible for marshaling itself when encountered.

type Reader ¶

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

A Reader for BARE primitive types.

func NewReader ¶

func NewReader(base io.Reader) *Reader

Returns a new BARE primitive reader wrapping the given io.Reader.

func (*Reader) ReadBool ¶

func (r *Reader) ReadBool() (bool, error)

func (*Reader) ReadData ¶

func (r *Reader) ReadData() ([]byte, error)

Reads arbitrary data whose length is read from the message.

func (*Reader) ReadDataFixed ¶

func (r *Reader) ReadDataFixed(dest []byte) error

Reads a fixed amount of arbitrary data, defined by the length of the slice.

func (*Reader) ReadF32 ¶

func (r *Reader) ReadF32() (float32, error)

func (*Reader) ReadF64 ¶

func (r *Reader) ReadF64() (float64, error)

func (*Reader) ReadI16 ¶

func (r *Reader) ReadI16() (int16, error)

func (*Reader) ReadI32 ¶

func (r *Reader) ReadI32() (int32, error)

func (*Reader) ReadI64 ¶

func (r *Reader) ReadI64() (int64, error)

func (*Reader) ReadI8 ¶

func (r *Reader) ReadI8() (int8, error)

func (*Reader) ReadInt ¶

func (r *Reader) ReadInt() (int64, error)

func (*Reader) ReadString ¶

func (r *Reader) ReadString() (string, error)

func (*Reader) ReadU16 ¶

func (r *Reader) ReadU16() (uint16, error)

func (*Reader) ReadU32 ¶

func (r *Reader) ReadU32() (uint32, error)

func (*Reader) ReadU64 ¶

func (r *Reader) ReadU64() (uint64, error)

func (*Reader) ReadU8 ¶

func (r *Reader) ReadU8() (uint8, error)

func (*Reader) ReadUint ¶

func (r *Reader) ReadUint() (uint64, error)

type Uint ¶

type Uint uint64

Uint is a variable-length encoded unsigned integer.

type Union ¶

type Union interface {
	IsUnion()
}

Any type which is a union member must implement this interface. You must also call RegisterUnion for go-bare to marshal or unmarshal messages which utilize your union type.

type UnionTags ¶

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

func RegisterUnion ¶

func RegisterUnion(iface interface{}) *UnionTags

Registers a union type in this context. Pass the union interface and the list of types associated with it, sorted ascending by their union tag.

func (*UnionTags) Member ¶

func (ut *UnionTags) Member(t interface{}, tag uint64) *UnionTags

func (*UnionTags) TagFor ¶

func (ut *UnionTags) TagFor(v interface{}) (uint64, bool)

func (*UnionTags) TypeFor ¶

func (ut *UnionTags) TypeFor(tag uint64) (reflect.Type, bool)

type Unmarshalable ¶

type Unmarshalable interface {
	Unmarshal(r *Reader) error
}

A type which implements this interface will be responsible for unmarshaling itself when encountered.

type UnsupportedTypeError ¶

type UnsupportedTypeError struct {
	Type reflect.Type
}

func (*UnsupportedTypeError) Error ¶

func (e *UnsupportedTypeError) Error() string

type Writer ¶

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

A Writer for BARE primitive types.

func NewWriter ¶

func NewWriter(base io.Writer) *Writer

Returns a new BARE primitive writer wrapping the given io.Writer.

func (*Writer) WriteBool ¶

func (w *Writer) WriteBool(b bool) error

func (*Writer) WriteData ¶

func (w *Writer) WriteData(data []byte) error

Writes arbitrary data whose length is encoded into the message.

func (*Writer) WriteDataFixed ¶

func (w *Writer) WriteDataFixed(data []byte) error

Writes a fixed amount of arbitrary data, defined by the length of the slice.

func (*Writer) WriteF32 ¶

func (w *Writer) WriteF32(f float32) error

func (*Writer) WriteF64 ¶

func (w *Writer) WriteF64(f float64) error

func (*Writer) WriteI16 ¶

func (w *Writer) WriteI16(i int16) error

func (*Writer) WriteI32 ¶

func (w *Writer) WriteI32(i int32) error

func (*Writer) WriteI64 ¶

func (w *Writer) WriteI64(i int64) error

func (*Writer) WriteI8 ¶

func (w *Writer) WriteI8(i int8) error

func (*Writer) WriteInt ¶

func (w *Writer) WriteInt(i int64) error

func (*Writer) WriteString ¶

func (w *Writer) WriteString(str string) error

func (*Writer) WriteU16 ¶

func (w *Writer) WriteU16(i uint16) error

func (*Writer) WriteU32 ¶

func (w *Writer) WriteU32(i uint32) error

func (*Writer) WriteU64 ¶

func (w *Writer) WriteU64(i uint64) error

func (*Writer) WriteU8 ¶

func (w *Writer) WriteU8(i uint8) error

func (*Writer) WriteUint ¶

func (w *Writer) WriteUint(i uint64) error

Source Files ¶

errors.go limit.go marshal.go package.go reader.go unions.go unmarshal.go varint.go writer.go

Directories ¶