storage

Documentation

Index

• Variables
• type Driver
  • func AutoConfig() (*Driver, error)
  • func NewFileStorage() (*Driver, error)
  • func NewS3Storage() (*Driver, error)
  • func (d *Driver) Close() error
  • func (d *Driver) Delete(ctx context.Context, key string) error
  • func (d *Driver) Get(ctx context.Context, key string) ([]byte, error)
  • func (d *Driver) GetStream(ctx context.Context, key string) (io.ReadCloser, error)
  • func (d *Driver) Has(ctx context.Context, key string) (bool, error)
  • func (d *Driver) ProbeCSPUri(ctx context.Context) (string, error)
  • func (d *Driver) Put(ctx context.Context, key string, value []byte) (int, error)
  • func (d *Driver) PutStream(ctx context.Context, key string, r io.Reader) (int64, error)
  • func (d *Driver) URL(ctx context.Context, key string) *PresignedURL
  • func (d *Driver) WalkKeys(ctx context.Context, walk func(context.Context, string) error) error
• type PresignedURL

Variables

var (
	// Ptrs to underlying storage library errors.
	ErrAlreadyExists = storage.ErrAlreadyExists
	ErrNotFound      = storage.ErrNotFound
)

Types

type Driver

type Driver struct {
	// Underlying storage
	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) Close

func (d *Driver) Close() error

Close will close the storage, releasing any file locks.

func (*Driver) Delete

func (d *Driver) Delete(ctx context.Context, key string) error

Remove attempts to remove the supplied key (and corresponding value) from storage.

func (*Driver) Get

func (d *Driver) Get(ctx context.Context, key string) ([]byte, error)

Get returns the byte value for key in storage.

func (*Driver) GetStream

func (d *Driver) GetStream(ctx context.Context, key string) (io.ReadCloser, error)

GetStream returns an io.ReadCloser for the value bytes at key in the storage.

func (*Driver) Has

func (d *Driver) Has(ctx context.Context, key string) (bool, error)

Has checks if the supplied key is in the storage.

func (*Driver) ProbeCSPUri

func (d *Driver) ProbeCSPUri(ctx context.Context) (string, error)

ProbeCSPUri returns a URI string that can be added to a content-security-policy to allow requests to endpoints served by this driver.

If the driver is not backed by non-proxying S3, this will return an empty string and no error.

Otherwise, this function probes for a CSP URI by doing the following:

1. Create a temporary file in the S3 bucket.
2. Generate a pre-signed URL for that file.
3. Extract '[scheme]://[host]' from the URL.
4. Remove the temporary file.
5. Return the '[scheme]://[host]' string.

func (*Driver) Put

func (d *Driver) Put(ctx context.Context, key string, value []byte) (int, error)

Put writes the supplied value bytes at key in the storage

func (*Driver) PutStream

func (d *Driver) PutStream(ctx context.Context, key string, r io.Reader) (int64, error)

PutStream writes the bytes from supplied reader at key in the storage

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.

func (*Driver) WalkKeys

func (d *Driver) WalkKeys(ctx context.Context, walk func(context.Context, string) error) error

WalkKeys walks the keys in the storage.

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.