copier

README

go-copier

A simple Go utility to asynchronously copy streams.

Documentation

Index

• type CloseReader
• type CloseWriter
• type Copier
  • func New(dst io.Writer, src io.Reader) Copier
• type GracefulStopper
• type Group
  • func (g *Group) Add(dst io.Writer, src io.Reader) Copier
  • func (g *Group) AddCopier(copier Copier) Copier
  • func (g *Group) Shutdown(ctx context.Context) error
  • func (g *Group) Wait(ctx context.Context) error
• type Waiter

Types

type CloseReader

type CloseReader interface {
	CloseRead() error
}

type CloseWriter

type CloseWriter interface {
	CloseWrite() error
}

type Copier

type Copier interface {
	CloseReader
	CloseWriter
	GracefulStopper

	Written() int64
	Err() error

	Copy()
}

func New

func New(dst io.Writer, src io.Reader) Copier

type GracefulStopper

type GracefulStopper interface {
	Waiter
	Shutdown(ctx context.Context) error
}

type Group

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

func (*Group) Add

func (g *Group) Add(dst io.Writer, src io.Reader) Copier

func (*Group) AddCopier

func (g *Group) AddCopier(copier Copier) Copier

func (*Group) Shutdown

func (g *Group) Shutdown(ctx context.Context) error

func (*Group) Wait

func (g *Group) Wait(ctx context.Context) error

type Waiter

type Waiter interface {
	Wait(ctx context.Context) error
}