ampcodec

Documentation

Index

• Variables
• func NewDecoder(r io.Reader) (io.ReadCloser, error)
• func NopCloser(w io.Writer) io.WriteCloser
• type Encoder
  • func NewEncoder(w io.Writer) *Encoder
  • func (enc *Encoder) Close() (err error)
  • func (enc *Encoder) Write(p []byte) (n int, err error)
• type PaddingWriter
  • func NewPaddingWriter(w io.WriteCloser, pad string, step int) *PaddingWriter
  • func (pw *PaddingWriter) Close() error
  • func (pw *PaddingWriter) Write(p []byte) (int, error)

Variables

var (
	ErrEncoderClosed = errors.New("encoder is already closed")
)

Functions

func NewDecoder

func NewDecoder(r io.Reader) (io.ReadCloser, error)

NewDecoder extracts payload from an AMP page body r.

func NopCloser

func NopCloser(w io.Writer) io.WriteCloser

Types

type Encoder

type Encoder struct {

	// UseOldBoilerplate sets Encoder to write
	// deprecated AMP boilerplate. As it's much shorter
	// than the new one, one may benefit from using it
	// to save some bandwidth.
	// Note that it may stop working in future.
	UseOldBoilerplate bool
	// contains filtered or unexported fields
}

Encoder is an instance of AMP HTML encoder.

func NewEncoder

func NewEncoder(w io.Writer) *Encoder

func (*Encoder) Close

func (enc *Encoder) Close() (err error)

Close signals Encoder that there will be no data so it may write trailer.

func (*Encoder) Write

func (enc *Encoder) Write(p []byte) (n int, err error)

type PaddingWriter

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

PaddingWriter in an io.WriteCloser wrapper which inserts pads each step.

func NewPaddingWriter

func NewPaddingWriter(w io.WriteCloser, pad string, step int) *PaddingWriter

NewPaddingWriter creates a PaddingWriter which writes pad each step bytes.

func (*PaddingWriter) Close

func (pw *PaddingWriter) Close() error

Close closes underlying io.WriteCloser. It's an error to Write after Close.

func (*PaddingWriter) Write

func (pw *PaddingWriter) Write(p []byte) (int, error)