transform

Documentation

Index

• type BytesReader
• type FromTo
• type Transformer

Types

type BytesReader

type BytesReader interface {
	// The slice given by Bytes is valid for use only until the next buffer modification.
	// That is, if you want to use this value outside of the current transformer step,
	// you need to take a copy.
	Bytes() []byte

	io.Reader
}

BytesReader wraps the Bytes method, usually implemented by bytes.Buffer, and an io.Reader.

type FromTo

type FromTo interface {
	From() BytesReader
	To() io.Writer
}

FromTo is sent to each transformation step in the chain.

type Transformer

type Transformer func(ft FromTo) error

Transformer is the func that needs to be implemented by a transformation step.