packet

Documentation

Overview

Package packet provides functionalities for building, encoding and decoding data.

Index

• type Decoder
  • func NewDecoder(r io.Reader, t TagSet) *Decoder
  • func (d *Decoder) Decode(packet *Packet) error
• type Encoder
  • func NewEncoder(w io.Writer, t TagSet) *Encoder
  • func (e *Encoder) Encode(p *Packet) error
• type Metadata
• type Module
  • func NewModule(id string, payload []byte) (*Module, error)
  • func (m *Module) ID() string
  • func (m *Module) Payload() []byte
• type ModuleDecoder
  • func NewModuleDecoder(r io.Reader, t TagSet) *ModuleDecoder
  • func (d *ModuleDecoder) Decode(m *Module) error
• type ModuleEncoder
  • func NewModuleEncoder(w io.Writer, t TagSet) *ModuleEncoder
  • func (e *ModuleEncoder) Encode(m *Module) error
• type Packet
  • func New() *Packet
  • func (p *Packet) AddModule(id string, payload []byte) (*Module, error)
  • func (p *Packet) DelModule(id string) error
  • func (p *Packet) Module(id string) (*Module, error)
• type TagReader
  • func NewTagReader(r io.Reader, tag string) *TagReader
  • func (t *TagReader) Flush() error
  • func (t *TagReader) Read(p []byte) (int, error)
• type TagSet
• type TagWriter
  • func NewTagWriter(w io.Writer) *TagWriter
  • func (w *TagWriter) Write(tag string) (int, error)

Types

type Decoder

type Decoder struct {
	TagSet
	// contains filtered or unexported fields
}

func NewDecoder

func NewDecoder(r io.Reader, t TagSet) *Decoder

func (*Decoder) Decode

func (d *Decoder) Decode(packet *Packet) error

type Encoder

type Encoder struct {
	TagSet
	// contains filtered or unexported fields
}

func NewEncoder

func NewEncoder(w io.Writer, t TagSet) *Encoder

func (*Encoder) Encode

func (e *Encoder) Encode(p *Packet) error

type Metadata

type Metadata struct {
	Encoding    uint8
	Compression uint8
	Encryption  uint8
}

type Module

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

func NewModule

func NewModule(id string, payload []byte) (*Module, error)

func (*Module) ID

func (m *Module) ID() string

func (*Module) Payload

func (m *Module) Payload() []byte

type ModuleDecoder

type ModuleDecoder struct {
	TagSet
	// contains filtered or unexported fields
}

func NewModuleDecoder

func NewModuleDecoder(r io.Reader, t TagSet) *ModuleDecoder

func (*ModuleDecoder) Decode

func (d *ModuleDecoder) Decode(m *Module) error

type ModuleEncoder

type ModuleEncoder struct {
	TagSet
	// contains filtered or unexported fields
}

func NewModuleEncoder

func NewModuleEncoder(w io.Writer, t TagSet) *ModuleEncoder

func (*ModuleEncoder) Encode

func (e *ModuleEncoder) Encode(m *Module) error

type Packet

type Packet struct {
	M Metadata
	// contains filtered or unexported fields
}

func New

func New() *Packet

func (*Packet) AddModule

func (p *Packet) AddModule(id string, payload []byte) (*Module, error)

func (*Packet) DelModule

func (p *Packet) DelModule(id string) error

func (*Packet) Module

func (p *Packet) Module(id string) (*Module, error)

type TagReader

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

func NewTagReader

func NewTagReader(r io.Reader, tag string) *TagReader

func (*TagReader) Flush

func (t *TagReader) Flush() error

func (*TagReader) Read

func (t *TagReader) Read(p []byte) (int, error)

type TagSet

type TagSet struct {
	PacketOpeningTag string
	PacketClosingTag string
	ModuleOpeningTag string
	ModuleClosingTag string
	Separator        string
}

type TagWriter

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

func NewTagWriter

func NewTagWriter(w io.Writer) *TagWriter

func (*TagWriter) Write

func (w *TagWriter) Write(tag string) (int, error)