context

Documentation

Index

• type Context
  • func NewContext[P types.ParameterView](reader *reader.Reader, assembler *assembler.Assembler, hooks *hooks.Hooks[P], ...) *Context[P]
• type Decoders
• type ParameterParser
• type Pool
  • func NewPool[P any](maxCap int) *Pool[P]
  • func (p *Pool[P]) Get(n int) *PooledSlice[P]
  • func (p *Pool[P]) Put(wrapper *PooledSlice[P])
• type PooledSlice
• type ReliableHeaderParameterCount

Types

type Context

type Context[P types.ParameterView] struct {
	Reader        *reader.Reader
	Assembler     *assembler.Assembler
	Hooks         *hooks.Hooks[P]
	Decoders      Decoders[P]
	PoolParameter *Pool[P]
	PoolCommand   *Pool[types.Command[P]]
	Config        types.Config
}

Context is the main context for the parser. It contains the reader, assembler, hooks, decoders, and pools for the parser. It live as long as the parser is used.

func NewContext

func NewContext[P types.ParameterView](reader *reader.Reader, assembler *assembler.Assembler, hooks *hooks.Hooks[P], decoders Decoders[P], config types.Config) *Context[P]

type Decoders

type Decoders[P types.ParameterView] struct {
	ParameterParser              ParameterParser[P]
	ReliableHeaderParameterCount ReliableHeaderParameterCount
}

type ParameterParser

type ParameterParser[P types.ParameterView] interface {
	ParseInto(*reader.Reader, *hooks.Hooks[P], *P) error
}

ParameterParser is implemented by each protocol-version parameters package (v16, v18). It is wired once at Parser construction so the hot path

type Pool

type Pool[P any] struct {
	// contains filtered or unexported fields
}

func NewPool

func NewPool[P any](maxCap int) *Pool[P]

func (*Pool[P]) Get

func (p *Pool[P]) Get(n int) *PooledSlice[P]

func (*Pool[P]) Put

func (p *Pool[P]) Put(wrapper *PooledSlice[P])

type PooledSlice

type PooledSlice[P any] struct {
	Items []P
}

type ReliableHeaderParameterCount

type ReliableHeaderParameterCount interface {
	Count(*reader.Reader) (int, error)
}

ReliableHeaderParameterCount is implemented by each protocol-version reliable header parameter count package (v16, v18). It is used to count the number of parameters in a reliable header.