marshal

README

Go encoding library

Written in Goose for verification in Iris.

To translate with goose:

goose -out ~/code/perennial/external/Goose

Documentation

Index

• func ReadBool(b []byte) (bool, []byte)
• func ReadBytes(b []byte, l uint64) ([]byte, []byte)
• func ReadBytesCopy(b []byte, l uint64) ([]byte, []byte)
• func ReadInt(b []byte) (uint64, []byte)
• func ReadInt32(b []byte) (uint32, []byte)
• func ReadLenPrefixedBytes(b []byte) ([]byte, []byte)
• func WriteBool(b []byte, x bool) []byte
• func WriteBytes(b []byte, data []byte) []byte
• func WriteInt(b []byte, i uint64) []byte
• func WriteInt32(b []byte, i uint32) []byte
• func WriteLenPrefixedBytes(b []byte, bs []byte) []byte
• type Dec
  • func NewDec(b []byte) Dec
  • func (dec Dec) GetBool() bool
  • func (dec Dec) GetBytes(num uint64) []byte
  • func (dec Dec) GetInt() uint64
  • func (dec Dec) GetInt32() uint32
  • func (dec Dec) GetInts(num uint64) []uint64
• type Enc
  • func NewEnc(sz uint64) Enc
  • func NewEncFromSlice(b []byte) Enc
  • func (enc Enc) Finish() []byte
  • func (enc Enc) PutBool(b bool)
  • func (enc Enc) PutBytes(b []byte)
  • func (enc Enc) PutInt(x uint64)
  • func (enc Enc) PutInt32(x uint32)
  • func (enc Enc) PutInts(xs []uint64)

Functions

func ReadBool

func ReadBool(b []byte) (bool, []byte)

func ReadBytes

func ReadBytes(b []byte, l uint64) ([]byte, []byte)

ReadBytes reads `l` bytes from b and returns (bs, rest)

func ReadBytesCopy

func ReadBytesCopy(b []byte, l uint64) ([]byte, []byte)

Like ReadBytes, but avoids keeping the source slice [b] alive.

func ReadInt

func ReadInt(b []byte) (uint64, []byte)

func ReadInt32

func ReadInt32(b []byte) (uint32, []byte)

func ReadLenPrefixedBytes

func ReadLenPrefixedBytes(b []byte) ([]byte, []byte)

func WriteBool

func WriteBool(b []byte, x bool) []byte

func WriteBytes

func WriteBytes(b []byte, data []byte) []byte

Append data to b, returning the new slice.

func WriteInt

func WriteInt(b []byte, i uint64) []byte

WriteInt appends i in little-endian format to b, returning the new slice.

func WriteInt32

func WriteInt32(b []byte, i uint32) []byte

WriteInt32 appends 32-bit integer i in little-endian format to b, returning the new slice.

func WriteLenPrefixedBytes

func WriteLenPrefixedBytes(b []byte, bs []byte) []byte

Types

type Dec

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

Dec is a stateful decoder that returns values encoded sequentially in a single slice.

func NewDec

func NewDec(b []byte) Dec

func (Dec) GetBool

func (dec Dec) GetBool() bool

func (Dec) GetBytes

func (dec Dec) GetBytes(num uint64) []byte

func (Dec) GetInt

func (dec Dec) GetInt() uint64

func (Dec) GetInt32

func (dec Dec) GetInt32() uint32

func (Dec) GetInts

func (dec Dec) GetInts(num uint64) []uint64

type Enc

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

Enc is a stateful encoder for a statically-allocated array.

func NewEnc

func NewEnc(sz uint64) Enc

func NewEncFromSlice

func NewEncFromSlice(b []byte) Enc

func (Enc) Finish

func (enc Enc) Finish() []byte

func (Enc) PutBool

func (enc Enc) PutBool(b bool)

func (Enc) PutBytes

func (enc Enc) PutBytes(b []byte)

func (Enc) PutInt

func (enc Enc) PutInt(x uint64)

func (Enc) PutInt32

func (enc Enc) PutInt32(x uint32)

func (Enc) PutInts

func (enc Enc) PutInts(xs []uint64)