tuple

Documentation

Index

• Variables
• type Coder
  • func NewCoder() *Coder
  • func (s *Coder) DecodeKey(b []byte) (document.Key, error)
  • func (s *Coder) EncodeKey(key document.Key) ([]byte, error)
  • func (s *Coder) ServiceName() string
  • func (s *Coder) ServiceType() plugins.ServiceType
  • func (s *Coder) SetConfig(conf config.Config)
  • func (s *Coder) Start() error
  • func (s Coder) Stop() error

Variables

var ErrUnsupportedKeyType = errors.New("unsupported key type")

Types

type Coder

type Coder struct {
}

Coder represents a CBOR erializer.

func NewCoder

func NewCoder() *Coder

NewCoder returns a new CBOR erializer instance.

func (*Coder) DecodeKey

func (s *Coder) DecodeKey(b []byte) (document.Key, error)

DecodeKey returns the decoded key from the specified bytes if available, otherwise returns an error.

func (*Coder) EncodeKey

func (s *Coder) EncodeKey(key document.Key) ([]byte, error)

EncodeKey returns the encoded bytes from the specified key if available, otherwise returns an error.

func (*Coder) ServiceName

func (s *Coder) ServiceName() string

ServiceName returns the plug-in service name.

func (*Coder) ServiceType

func (s *Coder) ServiceType() plugins.ServiceType

ServiceType returns the plug-in service type.

func (*Coder) SetConfig

func (s *Coder) SetConfig(conf config.Config)

SetConfig sets the specified configuration.

func (*Coder) Start

func (s *Coder) Start() error

Start starts this coder.

func (Coder) Stop

func (s Coder) Stop() error

Stop stops this coder.