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 ProgressMarker
  • func (m *ProgressMarker) Mark(ctx context.Context, key string) error
  • func (m *ProgressMarker) Unmark(ctx context.Context, key string) 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
	types.Storage
}

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

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

func (*InProgress) Exists

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

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

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

func (*InProgress) Get

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

Get returns the digest for the given key.

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

type ProgressMarker

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

ProgressMarker is an implementation of Marker which allows for marking/unmarking of digests in progress

func (*ProgressMarker) Mark

func (m *ProgressMarker) Mark(ctx context.Context, key string) error

Mark flags the digest identified by key as being "in progress"

func (*ProgressMarker) Unmark

func (m *ProgressMarker) Unmark(ctx context.Context, key string) error

Unmark flags the digest identified by key as not being "in progress"

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 digests

func (*S3) Exists

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

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

func (*S3) Get

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

Get returns the digest for the given key. The digest 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 digest. It is the caller's responsibility to call Close on the Reader when done.