remotestorage

Documentation

Index

• Variables
• type EntryInfo
• type Storage

Variables

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

Types

type EntryInfo

type EntryInfo struct {
	Name string
	Size int64
}

type Storage

type Storage interface {
	// Kind returns the kind of remote storage, e.g. `s3`
	Kind() string

	// String returns a human-readable representation of the storage
	String() string

	// Get opens a remote resource, if size < 0, read as much as possible
	Get(ctx context.Context, name string, offs, size int64) (io.ReadCloser, error)

	// Put saves a local file to a remote storage
	Put(ctx context.Context, name string, fileName string) error

	// Exists checks if a remove resource exists and can be read.
	// Note that due to an asynchronous nature of cluod storage,
	// a resource stored with the Put method may not be immediately accessible.
	Exists(ctx context.Context, name string) (bool, error)

	// ListEntries list all entries available in the remote storage,
	// Entries must be sorted alphabetically
	ListEntries(ctx context.Context, path string) (entries []EntryInfo, subPaths []string, err error)
}