piper

Documentation

Index

• Variables
• func NewDebug(prefix string, r io.Reader, w io.Writer) io.ReadWriter
• func NopCloser(w io.Writer) io.WriteCloser
• type AES
  • func (a *AES) Decoder(r io.Reader) (io.ReadCloser, error)
  • func (a *AES) Encoder(w io.Writer) (io.WriteCloser, error)
• type Base64
  • func (e *Base64) Decoder(r io.Reader) (io.ReadCloser, error)
  • func (e *Base64) Encoder(w io.Writer) (io.WriteCloser, error)
• type Buffer
  • func (b *Buffer) Consume(dst []byte) int
• type Debug
  • func (d *Debug) Read(p []byte) (n int, err error)
  • func (d *Debug) Write(p []byte) (n int, err error)
• type EncodeDecoder
  • func Join(list ...EncodeDecoder) EncodeDecoder
  • func NewAES(key []byte, guard int) EncodeDecoder
  • func NewBase64() EncodeDecoder
  • func NewGzip() EncodeDecoder
• type EncodeDecoderFn
  • func (ed *EncodeDecoderFn) Decoder(r io.Reader) (io.ReadCloser, error)
  • func (ed *EncodeDecoderFn) Encoder(w io.Writer) (io.WriteCloser, error)
• type EndErrors
  • func (e EndErrors) Error() string
• type Ender
  • func NewEnder(rw io.ReadWriteCloser) *Ender
  • func (e Ender) Close() error
  • func (e Ender) End(err error) error
  • func (e Ender) Read(p []byte) (n int, err error)
  • func (e Ender) Write(p []byte) (n int, err error)
• type Gzip
  • func (g *Gzip) Decoder(r io.Reader) (io.ReadCloser, error)
  • func (g *Gzip) Encoder(w io.Writer) (io.WriteCloser, error)
• type ReadClose
  • func (rc ReadClose) Close() error
  • func (rc ReadClose) Read(p []byte) (n int, err error)
• type ReadEnder
  • func NewReadEnder(r io.Reader) *ReadEnder
  • func (r ReadEnder) Read(p []byte) (n int, err error)
• type Transformer
  • func NewTransformer(t func() ([]byte, error)) *Transformer
  • func (t *Transformer) Read(p []byte) (n int, err error)
• type Transparent
  • func (t *Transparent) Decoder(r io.Reader) (io.ReadCloser, error)
  • func (t *Transparent) Encoder(w io.Writer) (io.WriteCloser, error)
• type WrapReadCloser
  • func (w *WrapReadCloser) Close() error
  • func (w *WrapReadCloser) Read(p []byte) (n int, err error)
• type WriteClose
  • func (wc WriteClose) Close() error
  • func (wc WriteClose) Write(p []byte) (n int, err error)
• type WriteEnder
  • func NewWriteEnder(w io.WriteCloser) *WriteEnder
  • func (w WriteEnder) Close() error
  • func (w WriteEnder) End(e error) error
  • func (w WriteEnder) Write(p []byte) (n int, err error)

Variables

var ErrAESDecode = errors.New("wrong secret or corrupted data")

Functions

func NewDebug

func NewDebug(prefix string, r io.Reader, w io.Writer) io.ReadWriter

func NopCloser

func NopCloser(w io.Writer) io.WriteCloser

Types

type AES

type AES struct {
	Key   []byte
	Guard int
}

func (*AES) Decoder

func (a *AES) Decoder(r io.Reader) (io.ReadCloser, error)

func (*AES) Encoder

func (a *AES) Encoder(w io.Writer) (io.WriteCloser, error)

type Base64

type Base64 struct {
	Encoding *base64.Encoding
}

func (*Base64) Decoder

func (e *Base64) Decoder(r io.Reader) (io.ReadCloser, error)

func (*Base64) Encoder

func (e *Base64) Encoder(w io.Writer) (io.WriteCloser, error)

type Buffer

type Buffer []byte

func (*Buffer) Consume

func (b *Buffer) Consume(dst []byte) int

Consume consumes the buffer to dst and returns the number of bytes consumed.

type Debug

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

func (*Debug) Read

func (d *Debug) Read(p []byte) (n int, err error)

func (*Debug) Write

func (d *Debug) Write(p []byte) (n int, err error)

type EncodeDecoder

type EncodeDecoder interface {
	// Encoder returns a writer that will encode data to out.
	// When the Close method is called, it should not close the underlying writer,
	// it should only flush the pending data from buffer.
	Encoder(out io.Writer) (io.WriteCloser, error)

	// Decoder returns a reader that will decode the data from in.
	Decoder(in io.Reader) (io.ReadCloser, error)
}

func Join

func Join(list ...EncodeDecoder) EncodeDecoder

func NewAES

func NewAES(key []byte, guard int) EncodeDecoder

NewAES creates a new AES encoder/decoder. The aesType must be 0, 16, 24, or 32 to select, if it's 0, no KDF will be used, the key will be used directly.

func NewBase64

func NewBase64() EncodeDecoder

func NewGzip

func NewGzip() EncodeDecoder

type EncodeDecoderFn

type EncodeDecoderFn struct {
	E func(io.Writer) (io.WriteCloser, error)
	D func(io.Reader) (io.ReadCloser, error)
}

func (*EncodeDecoderFn) Decoder

func (ed *EncodeDecoderFn) Decoder(r io.Reader) (io.ReadCloser, error)

func (*EncodeDecoderFn) Encoder

func (ed *EncodeDecoderFn) Encoder(w io.Writer) (io.WriteCloser, error)

type EndErrors

type EndErrors []byte

func (EndErrors) Error

func (e EndErrors) Error() string

type Ender

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

Ender acts like a proxy for the a io.ReadWriteCloser. The writer can send EndErrors to the reader. It will use json to marshal the error for the reader.

func NewEnder

func NewEnder(rw io.ReadWriteCloser) *Ender

func (Ender) Close

func (e Ender) Close() error

func (Ender) End

func (e Ender) End(err error) error

func (Ender) Read

func (e Ender) Read(p []byte) (n int, err error)

func (Ender) Write

func (e Ender) Write(p []byte) (n int, err error)

type Gzip

type Gzip struct {
	Level int
}

func (*Gzip) Decoder

func (g *Gzip) Decoder(r io.Reader) (io.ReadCloser, error)

func (*Gzip) Encoder

func (g *Gzip) Encoder(w io.Writer) (io.WriteCloser, error)

type ReadClose

type ReadClose struct {
	R func(p []byte) (n int, err error)
	C func() error
}

func (ReadClose) Close

func (rc ReadClose) Close() error

func (ReadClose) Read

func (rc ReadClose) Read(p []byte) (n int, err error)

type ReadEnder

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

func NewReadEnder

func NewReadEnder(r io.Reader) *ReadEnder

func (ReadEnder) Read

func (r ReadEnder) Read(p []byte) (n int, err error)

type Transformer

type Transformer struct {
	Transform func() ([]byte, error)
	// contains filtered or unexported fields
}

func NewTransformer

func NewTransformer(t func() ([]byte, error)) *Transformer

func (*Transformer) Read

func (t *Transformer) Read(p []byte) (n int, err error)

type Transparent

type Transparent struct{}

func (*Transparent) Decoder

func (t *Transparent) Decoder(r io.Reader) (io.ReadCloser, error)

func (*Transparent) Encoder

func (t *Transparent) Encoder(w io.Writer) (io.WriteCloser, error)

type WrapReadCloser

type WrapReadCloser struct {
	Reader io.Reader
	Closer io.Closer
}

func (*WrapReadCloser) Close

func (w *WrapReadCloser) Close() error

func (*WrapReadCloser) Read

func (w *WrapReadCloser) Read(p []byte) (n int, err error)

type WriteClose

type WriteClose struct {
	W func(p []byte) (n int, err error)
	C func() error
}

func (WriteClose) Close

func (wc WriteClose) Close() error

func (WriteClose) Write

func (wc WriteClose) Write(p []byte) (n int, err error)

type WriteEnder

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

func NewWriteEnder

func NewWriteEnder(w io.WriteCloser) *WriteEnder

func (WriteEnder) Close

func (w WriteEnder) Close() error

func (WriteEnder) End

func (w WriteEnder) End(e error) error

func (WriteEnder) Write

func (w WriteEnder) Write(p []byte) (n int, err error)