content

Documentation

Index

• type S3Client
• type S3ReadCloser
• type S3StreamWriter
  • func NewStreamWriter(s3c S3Client) *S3StreamWriter
  • func (s S3StreamWriter) StreamAndWrite(ctx context.Context, s3Path string, w io.Writer) (err error)
• type Writer

Types

type S3Client

type S3Client interface {
	Get(key string) (io.ReadCloser, *int64, error)
	Checker(ctx context.Context, check *healthcheck.CheckState) error
}

S3Client is an interface to represent methods called to retrieve from s3

type S3ReadCloser

type S3ReadCloser io.ReadCloser

S3ReadCloser is an io.ReadCloser alias to allow mockgen to create a mock impl for the tests

type S3StreamWriter

type S3StreamWriter struct {
	S3Client S3Client
}

S3StreamWriter provides functionality for retrieving content from an S3 bucket. The content is streamed and and written to the provided io.Writer

func NewStreamWriter

func NewStreamWriter(s3c S3Client) *S3StreamWriter

NewStreamWriter create a new S3StreamWriter instance.

func (S3StreamWriter) StreamAndWrite

func (s S3StreamWriter) StreamAndWrite(ctx context.Context, s3Path string, w io.Writer) (err error)

StreamAndWrite stream the request file writing the content to the provided io.Writer.

type Writer

type Writer io.Writer

Writer is an io.Writer alias to allow mockgen to create a mock impl for the tests