storage

Documentation

Index

• func BuildKey(path string) string
• func DeleteObject(ctx context.Context, key string) error
• func IsEnabled() bool
• func PutObject(ctx context.Context, key string, body io.Reader, size int64, ...) error
• type ErrS3InitializationFailed
  • func (e ErrS3InitializationFailed) Error() string
• type LocalCacheError
  • func (e LocalCacheError) Error() string
• type ObjectInfo
  • func GetObject(ctx context.Context, key string) (*ObjectInfo, error)
  • func GetObjectViaCache(ctx context.Context, key string) (*ObjectInfo, error)
  • func GetObjectViaProxy(ctx context.Context, key string) (*ObjectInfo, error)

Functions

func BuildKey

func BuildKey(path string) string

BuildKey constructs a full S3 object key with the configured prefix.

func DeleteObject

func DeleteObject(ctx context.Context, key string) error

DeleteObject deletes a file from S3.

func IsEnabled

func IsEnabled() bool

func PutObject

func PutObject(ctx context.Context, key string, body io.Reader, size int64, contentType string) error

PutObject uploads a file to S3.

Types

type ErrS3InitializationFailed

type ErrS3InitializationFailed struct{}

func (ErrS3InitializationFailed) Error

func (e ErrS3InitializationFailed) Error() string

type LocalCacheError

type LocalCacheError struct{}

func (LocalCacheError) Error

func (e LocalCacheError) Error() string

type ObjectInfo

type ObjectInfo struct {
	CachePath     string
	Body          io.ReadCloser
	ContentLength int64
	ContentType   string
}

ObjectInfo holds metadata about a retrieved object.

func GetObject

func GetObject(ctx context.Context, key string) (*ObjectInfo, error)

GetObject retrieves a file directly from S3.

func GetObjectViaCache

func GetObjectViaCache(ctx context.Context, key string) (*ObjectInfo, error)

func GetObjectViaProxy

func GetObjectViaProxy(ctx context.Context, key string) (*ObjectInfo, error)

GetObjectViaProxy retrieves a file via CDN if configured, otherwise falls back to S3.