reader

Documentation

Overview

Package reader provides the reader functions for handling with s3. This package is wrapping package of "https://github.com/aws/aws-sdk-go".

Index

• type MockIO
  • func (m *MockIO) NewReadCloserWithContext(ctx context.Context, r io.ReadCloser) (io.ReadCloser, error)
  • func (m *MockIO) NewReaderWithContext(ctx context.Context, r io.Reader) (io.Reader, error)
• type MockReadCloser
  • func (m *MockReadCloser) Close() error
  • func (m *MockReadCloser) Read(p []byte) (n int, err error)
• type MockReader
  • func (m *MockReader) Close() error
  • func (m *MockReader) Open(ctx context.Context, key string) error
  • func (m *MockReader) Read(p []byte) (n int, err error)
• type MockS3API
  • func (m *MockS3API) GetObjectWithContext(ctx aws.Context, in *s3.GetObjectInput, opts ...request.Option) (*s3.GetObjectOutput, error)
• type Option
  • func WithBackoff(enabled bool) Option
  • func WithBackoffOpts(opts ...backoff.Option) Option
  • func WithBucket(bucket string) Option
  • func WithErrGroup(eg errgroup.Group) Option
  • func WithMaxChunkSize(size int64) Option
  • func WithService(s s3iface.S3API) Option
• type Reader
  • func New(opts ...Option) (Reader, error)

Types

type MockIO

type MockIO struct {
	NewReaderWithContextFunc     func(ctx context.Context, r io.Reader) (io.Reader, error)
	NewReadCloserWithContextFunc func(ctx context.Context, r io.ReadCloser) (io.ReadCloser, error)
}

MockIO represents mock for io.IO.

func (*MockIO) NewReadCloserWithContext

func (m *MockIO) NewReadCloserWithContext(ctx context.Context, r io.ReadCloser) (io.ReadCloser, error)

NewReadCloserWithContext calls NewReadCloserWithContextFunc.

func (*MockIO) NewReaderWithContext

func (m *MockIO) NewReaderWithContext(ctx context.Context, r io.Reader) (io.Reader, error)

NewReaderWithContext calls NewReaderWithContextFunc.

type MockReadCloser

type MockReadCloser struct {
	ReadFunc  func(p []byte) (n int, err error)
	CloseFunc func() error
}

MockReadCloser represents mock for io.ReadCloser.

func (*MockReadCloser) Close

func (m *MockReadCloser) Close() error

Close calls CloseFunc.

func (*MockReadCloser) Read

func (m *MockReadCloser) Read(p []byte) (n int, err error)

Read calls ReadFunc.

type MockReader

type MockReader struct {
	OpenFunc  func(ctx context.Context, key string) error
	ReadFunc  func(p []byte) (n int, err error)
	CloseFunc func() error
}

MockReader represents mock for Reader.

func (*MockReader) Close

func (m *MockReader) Close() error

Close calls CloseFunc.

func (*MockReader) Open

func (m *MockReader) Open(ctx context.Context, key string) error

Open calls OpenFunc.

func (*MockReader) Read

func (m *MockReader) Read(p []byte) (n int, err error)

Read calls ReadFunc.

type MockS3API

type MockS3API struct {
	s3iface.S3API
	GetObjectWithContextFunc func(aws.Context, *s3.GetObjectInput, ...request.Option) (*s3.GetObjectOutput, error)
}

MockS3API represents mock for s3iface.MMockS3API.

func (*MockS3API) GetObjectWithContext

func (m *MockS3API) GetObjectWithContext(ctx aws.Context, in *s3.GetObjectInput, opts ...request.Option) (*s3.GetObjectOutput, error)

GetObjectWithContext calls GetObjectWithContextFunc.

type Option

type Option func(r *reader)

Option represents the functional option for reader.

func WithBackoff

func WithBackoff(enabled bool) Option

WithBackoff returns the option to set the backoffEnabled.

func WithBackoffOpts

func WithBackoffOpts(opts ...backoff.Option) Option

WithBackoffOpts returns the option to set the backoffOpts.

func WithBucket

func WithBucket(bucket string) Option

WithBucket returns the option to set the bucket.

func WithErrGroup

func WithErrGroup(eg errgroup.Group) Option

WithErrGroup returns the option to set the eg.

func WithMaxChunkSize

func WithMaxChunkSize(size int64) Option

WithMaxChunkSize retunrs the option to set the maxChunkSize.

func WithService

func WithService(s s3iface.S3API) Option

WithService returns the option to set the service.

type Reader

type Reader interface {
	Open(ctx context.Context, key string) error
	io.ReadCloser
}

Reader is an interface that groups the basic Read and Close and Open methods.

func New

func New(opts ...Option) (Reader, error)

New returns Reader implementation.