storage

Documentation

Index

• type InProgress
  • func (s *InProgress) Exists(ctx context.Context, key string) (bool, error)
  • func (s *InProgress) Get(ctx context.Context, key string) (io.ReadCloser, error)
• type S3
  • func (s *S3) Exists(ctx context.Context, key string) (bool, error)
  • func (s *S3) Get(ctx context.Context, key string) (io.ReadCloser, error)
  • func (s *S3) Store(ctx context.Context, key string, data io.ReadCloser) error

Types

type InProgress

type InProgress struct {
	Bucket  string
	Timeout time.Duration
	Client  s3iface.S3API
	domain.Storage
}

InProgress is an implementation of Storage which is intended to decorate the S3 implementation.

The decorator will check if a diff is in progress, and if so, will return domain.ErrInProgress. On a successful Store operation, the decorator will remove the diff's "in progress" status.

func (*InProgress) Exists

func (s *InProgress) Exists(ctx context.Context, key string) (bool, error)

Exists returns true if the diff exists, but does not download the diff body.

If the diff is in the process of being created, an error will be returned of type domain.ErrInProgress

func (*InProgress) Get

func (s *InProgress) Get(ctx context.Context, key string) (io.ReadCloser, error)

Get returns the diff for the given key.

If the diff is in the process of being created, an error will be returned of type domain.ErrInProgress

type S3

type S3 struct {
	Bucket string
	Client s3iface.S3API
	// contains filtered or unexported fields
}

S3 implements the Storage interface and uses S3 as the backing store for diffs

func (*S3) Exists

func (s *S3) Exists(ctx context.Context, key string) (bool, error)

Exists returns true if the diff exists, but does not download the diff.

func (*S3) Get

func (s *S3) Get(ctx context.Context, key string) (io.ReadCloser, error)

Get returns the diff for the given key. The diff is returned as a gzipped payload. It is the caller's responsibility to call Close on the Reader when done.

func (*S3) Store

func (s *S3) Store(ctx context.Context, key string, data io.ReadCloser) error

Store stores the diff. It is the caller's responsibility to call Close on the Reader when done.