benc

README

Benc

The fastest serializer in pure Golang, with the option for backward/forward compatibile generated code.

This module is split into four main packages:

• cmd/bencgen - the code-generator for benc
• impl/gen - the implementation for bencgen, for handling backward and forward compatibility
• std - the benc standard, raw serialization
• idv - the benc ID validation, raw serialization with ID prefixing

Security

Benchmarks

benc.go

benc.go provides methods to do buffer reusing and to verify the marshal/unmarshal process.

License

MIT

Documentation

Index

• Constants
• Variables
• func VerifyMarshal(n int, b []byte) error
• func VerifyUnmarshal(n int, b []byte) error
• func WithBufferSize(bufSize uint) optFunc
• type BufPool
  • func NewBufPool(opts ...optFunc) *BufPool
  • func (bp *BufPool) Marshal(s int, f func(b []byte) (n int)) ([]byte, error)
• type Opts

Constants

const (
	Bytes2 int = 2
	Bytes4 int = 4
	Bytes8 int = 8
)

Variables

var ErrBufTooSmall = errors.New("buffer too small")

var ErrOverflow = errors.New("varint overflows a 64-bit integer")

var ErrReuseBufTooSmall = errors.New("reuse buffer too small")

var ErrVerifyMarshal = errors.New("check for a mistake in calculating the size or in the marshal process")

var ErrVerifyUnmarshal = errors.New("check for a mistake in the unmarshal process")

Functions

func VerifyMarshal

func VerifyMarshal(n int, b []byte) error

Verifies that the length of the buffer equals n

func VerifyUnmarshal

func VerifyUnmarshal(n int, b []byte) error

Verifies that the length of the buffer equals n

func WithBufferSize

func WithBufferSize(bufSize uint) optFunc

Types

type BufPool

type BufPool struct {
	BufSize uint
	// contains filtered or unexported fields
}

func NewBufPool

func NewBufPool(opts ...optFunc) *BufPool

func (*BufPool) Marshal

func (bp *BufPool) Marshal(s int, f func(b []byte) (n int)) ([]byte, error)

Initialises the marshal process, it reuses the buffers from a buf pool instance

s = size of the data in bytes, retrieved by using the benc `Size...` methods

type Opts

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