storage

type Compressor interface {
	// Reader returns a new decompressing io.ReadCloser based on supplied (compressed) io.Reader
	Reader(io.ReadCloser) (io.ReadCloser, error)

	// Writer returns a new compressing io.WriteCloser based on supplied (uncompressed) io.Writer
	Writer(io.WriteCloser) (io.WriteCloser, error)
}

type DiskConfig struct {
	// Transform is the supplied key <--> path KeyTransform.
	Transform KeyTransform

	// WriteBufSize is the buffer size to use when writing file streams.
	WriteBufSize int

	// Overwrite allows overwriting values of stored keys in the storage.
	Overwrite bool

	// LockFile allows specifying the filesystem path to use for the lockfile,
	// providing only a filename it will store the lockfile within provided store
	// path and nest the store under `path/store` to prevent access to lockfile.
	LockFile string

	// Compression is the Compressor to use when reading / writing files,
	// default is no compression.
	Compression Compressor
}

type DiskStorage struct {
	// contains filtered or unexported fields
}

type Entry struct {
	// Key is this entry's unique storage key.
	Key string

	// Size is the size of this entry in storage.
	// Note that size < 0 indicates unknown.
	Size int64
}

type KeyTransform interface {
	// KeyToPath converts a supplied key to storage path
	KeyToPath(string) string

	// PathToKey converts a supplied storage path to key
	PathToKey(string) string
}

type Lock struct {
	// contains filtered or unexported fields
}

type MemoryStorage struct {
	// contains filtered or unexported fields
}

type S3Config struct {
	// CoreOpts are S3 client options passed during initialization.
	CoreOpts minio.Options

	// GetOpts are S3 client options passed during .Read___() calls.
	GetOpts minio.GetObjectOptions

	// PutOpts are S3 client options passed during .Write___() calls.
	PutOpts minio.PutObjectOptions

	// PutChunkSize is the chunk size (in bytes) to use when sending
	// a byte stream reader of unknown size as a multi-part object.
	PutChunkSize int64

	// PutChunkOpts are S3 client options passed during chunked .Write___() calls.
	PutChunkOpts minio.PutObjectPartOptions

	// StatOpts are S3 client options passed during .Stat() calls.
	StatOpts minio.StatObjectOptions

	// RemoveOpts are S3 client options passed during .Remove() calls.
	RemoveOpts minio.RemoveObjectOptions

	// ListSize determines how many items to include in each
	// list request, made during calls to .WalkKeys().
	ListSize int
}

type S3Storage struct {
	// contains filtered or unexported fields
}

type Storage interface {
	// ReadBytes returns the byte value for key in storage
	ReadBytes(ctx context.Context, key string) ([]byte, error)

	// ReadStream returns an io.ReadCloser for the value bytes at key in the storage
	ReadStream(ctx context.Context, key string) (io.ReadCloser, error)

	// WriteBytes writes the supplied value bytes at key in the storage
	WriteBytes(ctx context.Context, key string, value []byte) (int, error)

	// WriteStream writes the bytes from supplied reader at key in the storage
	WriteStream(ctx context.Context, key string, r io.Reader) (int64, error)

	// Stat checks if the supplied key is in the storage
	Stat(ctx context.Context, key string) (bool, error)

	// Remove attempts to remove the supplied key-value pair from storage
	Remove(ctx context.Context, key string) error

	// Close will close the storage, releasing any file locks
	Close() error

	// Clean removes unused values and unclutters the storage (e.g. removing empty folders)
	Clean(ctx context.Context) error

	// WalkKeys walks the keys in the storage
	WalkKeys(ctx context.Context, opts WalkKeysOptions) error
}

type WalkKeysOptions struct {
	// WalkFn is the function to apply on each StorageEntry
	WalkFn func(context.Context, Entry) error
}