pktline

Documentation

Index

• Constants
• Variables
• func Encode(line []byte) (string, error)
• func EncodeFromString(line string) (string, error)
• type Decoder
  • func NewDecoder(r io.Reader) *Decoder
  • func (d *Decoder) ReadAll() ([]string, error)
  • func (d *Decoder) ReadBlock() ([]string, error)
  • func (d *Decoder) ReadLine() (string, error)
• type Encoder
  • func NewEncoder() *Encoder
  • func (e *Encoder) AddFlush()
  • func (e *Encoder) AddLine(line string) error
  • func (e *Encoder) Reader() *strings.Reader

Constants

const (
	// HeaderLength length of the pktline header
	HeaderLength = 4
	// MaxLength max line length
	MaxLength = 65524
)

Variables

var (
	// ErrUnderflow is triggered when a line is shorter than the described length
	ErrUnderflow = errors.New("unexpected string length (underflow)")
	// ErrInvalidHeader invalid pktline header
	ErrInvalidHeader = errors.New("invalid header")
	// ErrInvalidLen ivanlid line length found, < 0
	ErrInvalidLen = errors.New("invalid length")
)

var (
	//ErrOverflow is triggered when the line length exceed the MaxLength
	ErrOverflow = errors.New("unexpected string length (overflow)")
)

Functions

func Encode

func Encode(line []byte) (string, error)

Encode encodes a byte slice to pkt-line format

func EncodeFromString

func EncodeFromString(line string) (string, error)

EncodeFromString encodes a string to pkt-line format

Types

type Decoder

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

Decoder implements a pkt-line format decoder

func NewDecoder

func NewDecoder(r io.Reader) *Decoder

NewDecoder returns a new Decoder

func (*Decoder) ReadAll

func (d *Decoder) ReadAll() ([]string, error)

ReadAll read and returns all the lines

func (*Decoder) ReadBlock

func (d *Decoder) ReadBlock() ([]string, error)

ReadBlock reads and return multiple pkt-line lines, it stops at the end of the reader or if a flush-pkt is reached

func (*Decoder) ReadLine

func (d *Decoder) ReadLine() (string, error)

ReadLine reads and return one pkt-line line from the reader

type Encoder

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

Encoder implements a pkt-line format encoder

func NewEncoder

func NewEncoder() *Encoder

NewEncoder returns a new Encoder

func (*Encoder) AddFlush

func (e *Encoder) AddFlush()

AddFlush adds a flush-pkt to the encoder

func (*Encoder) AddLine

func (e *Encoder) AddLine(line string) error

AddLine encode and adds a line to the encoder

func (*Encoder) Reader

func (e *Encoder) Reader() *strings.Reader

Reader returns a string.Reader over the encoder