internal

Documentation

Overview

Package internal contains code that is shared among encoding implementations.

Index

• Variables
• type Encoding
  • func (e *Encoding) ID() (mib identifier.MIB, other string)
  • func (e *Encoding) String() string
• type FuncEncoding
  • func (e FuncEncoding) NewDecoder() *encoding.Decoder
  • func (e FuncEncoding) NewEncoder() *encoding.Encoder
• type RepertoireError
  • func (r RepertoireError) Error() string
  • func (r RepertoireError) Replacement() byte
• type SimpleEncoding
  • func (e *SimpleEncoding) NewDecoder() *encoding.Decoder
  • func (e *SimpleEncoding) NewEncoder() *encoding.Encoder

Variables

var ErrASCIIReplacement = RepertoireError(encoding.ASCIISub)

Types

type Encoding

type Encoding struct {
	encoding.Encoding
	Name string
	MIB  identifier.MIB
}

Encoding is an implementation of the Encoding interface that adds the String and ID methods to an existing encoding.

func (*Encoding) ID

func (e *Encoding) ID() (mib identifier.MIB, other string)

func (*Encoding) String

func (e *Encoding) String() string

type FuncEncoding

type FuncEncoding struct {
	Decoder func() transform.Transformer
	Encoder func() transform.Transformer
}

FuncEncoding is an Encoding that combines two functions returning a new Transformer.

func (FuncEncoding) NewDecoder

func (e FuncEncoding) NewDecoder() *encoding.Decoder

func (FuncEncoding) NewEncoder

func (e FuncEncoding) NewEncoder() *encoding.Encoder

type RepertoireError

type RepertoireError byte

A RepertoireError indicates a rune is not in the repertoire of a destination encoding. It is associated with an encoding-specific suggested replacement byte.

func (RepertoireError) Error

func (r RepertoireError) Error() string

Error implements the error interrface.

func (RepertoireError) Replacement

func (r RepertoireError) Replacement() byte

Replacement returns the replacement string associated with this error.

type SimpleEncoding

type SimpleEncoding struct {
	Decoder transform.Transformer
	Encoder transform.Transformer
}

SimpleEncoding is an Encoding that combines two Transformers.

func (*SimpleEncoding) NewDecoder

func (e *SimpleEncoding) NewDecoder() *encoding.Decoder

func (*SimpleEncoding) NewEncoder

func (e *SimpleEncoding) NewEncoder() *encoding.Encoder