storage

Documentation

Index

• Variables
• type Driver
  • func AutoConfig() (*Driver, error)
  • func NewFileStorage() (*Driver, error)
  • func NewS3Storage() (*Driver, error)
  • func (d *Driver) URL(ctx context.Context, key string) *PresignedURL
• type PresignedURL

Variables

var ErrAlreadyExists = storage.ErrAlreadyExists

ErrAlreadyExists is a ptr to underlying storage.ErrAlreadyExists, to put the related errors in the same package as our storage wrapper.

Types

type Driver

type Driver struct {
	// Underlying storage
	*kv.KVStore
	Storage storage.Storage

	// S3-only parameters
	Proxy          bool
	Bucket         string
	PresignedCache *ttl.Cache[string, PresignedURL]
}

Driver wraps a kv.KVStore to also provide S3 presigned GET URLs.

func AutoConfig

func AutoConfig() (*Driver, error)

func NewFileStorage

func NewFileStorage() (*Driver, error)

func NewS3Storage

func NewS3Storage() (*Driver, error)

func (*Driver) URL

func (d *Driver) URL(ctx context.Context, key string) *PresignedURL

URL will return a presigned GET object URL, but only if running on S3 storage with proxying disabled.

type PresignedURL

type PresignedURL struct {
	*url.URL
	Expiry time.Time // link expires at this time
}

PresignedURL represents a pre signed S3 URL with an expiry time.