storage

Documentation

Index

• Variables
• type Storage
• type UploadInfo

Variables

var ErrNotFound = errors.New("not found")

Types

type Storage

type Storage interface {
	// Download downloads a file from the storage backend to the given path.
	Download(object string, toPath string) error

	// Get returns the contents of a file from the storage backend.
	// Returns ErrNotFound if the file does not exist.
	Get(object string) ([]byte, error)

	// Put uploads a file to the storage backend.
	Put(object string, fromPath string) (*UploadInfo, error)

	// PutBytes uploads a file to the storage backend.
	PutBytes(object string, data []byte) (*UploadInfo, error)

	// Delete deletes a file from the storage backend.
	// Returns ErrNotFound if the file does not exist.
	Delete(object string) error

	// Exists checks if a file exists in the storage backend.
	// Returns false if the file does not exist.
	Exists(object string) (bool, error)

	// CanReadURI checks if a URI can be read by the storage backend.
	// Returns false if the URI cannot be read.
	CanReadURI(uri string) (bool, error)
}

Storage is an interface for storage backends. Usually S3, but can be anything.

type UploadInfo

type UploadInfo struct {
	// Location is the location of the uploaded file.
	Location string

	// VersionID is the version ID of the uploaded file.
	VersionID *string
}

UploadInfo is the information about an upload.