muxcodec

Documentation

Index

• Variables
• func CodecWithHeader(hdr []byte, codecs []mc.Multicodec) mc.Multicodec
• func SelectFirst(v interface{}, codecs []mc.Multicodec) mc.Multicodec
• type Multicodec
  • func MuxMulticodec(codecs []mc.Multicodec, sel SelectCodec) *Multicodec
  • func StandardMux() *Multicodec
  • func (c *Multicodec) Decoder(r io.Reader) mc.Decoder
  • func (c *Multicodec) Encoder(w io.Writer) mc.Encoder
  • func (c *Multicodec) Header() []byte
• type SelectCodec

Variables

var (
	ErrNoCodec = fmt.Errorf("no suitable codec")
)

var Header []byte

Functions

func CodecWithHeader

func CodecWithHeader(hdr []byte, codecs []mc.Multicodec) mc.Multicodec

func SelectFirst

func SelectFirst(v interface{}, codecs []mc.Multicodec) mc.Multicodec

SelectFirst is the default SelectCodec function. selects the first codec given.

Types

type Multicodec

type Multicodec struct {
	Codecs []mc.Multicodec // subcodecs to use
	Select SelectCodec     // pick a subcodec for encoding
	Wrap   bool            // whether to wrap with own header
	Last   mc.Multicodec   // the last subcodec used
}

func MuxMulticodec

func MuxMulticodec(codecs []mc.Multicodec, sel SelectCodec) *Multicodec

MuxMulticodec returns a multicodec that muxes between given codecs. It uses the given SelectCodec function when marshaling, to select the best codec to use.

func StandardMux

func StandardMux() *Multicodec

func (*Multicodec) Decoder

func (c *Multicodec) Decoder(r io.Reader) mc.Decoder

func (*Multicodec) Encoder

func (c *Multicodec) Encoder(w io.Writer) mc.Encoder

func (*Multicodec) Header

func (c *Multicodec) Header() []byte

type SelectCodec

type SelectCodec func(v interface{}, codecs []mc.Multicodec) mc.Multicodec

SelectCodec is a function that selects which codecs are able to marshal a given datastructure, and orders them (to be tried first).