-
Notifications
You must be signed in to change notification settings - Fork 342
/
pyramid.go
53 lines (43 loc) · 1.83 KB
/
pyramid.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
package pyramid
//go:generate go run github.com/golang/mock/mockgen@v1.6.0 -source=pyramid.go -destination=mock/pyramid.go -package=mock
import (
"context"
"io"
"os"
)
// FS is pyramid abstraction of filesystem where the persistent storage-layer is the block storage.
// Files on the local disk are transient and might be cleaned up by the eviction policy.
// File structure under a namespace and namespace itself are flat (no directories).
type FS interface {
// Create creates a new file in the FS.
// It will only be persistent after the returned file is stored.
Create(ctx context.Context, namespace string) (StoredFile, error)
// Open finds the referenced file and returns its read-only File.
// If file isn't in the local disk, it is fetched from the block storage.
Open(ctx context.Context, namespace, filename string) (File, error)
// Exists returns true if filename currently exists on block storage.
Exists(ctx context.Context, namespace, filename string) (bool, error)
// GetRemoteURI returns the URI for filename on block storage. That URI might not
// resolve if filename does not exist.
GetRemoteURI(ctx context.Context, namespace, filename string) (string, error)
}
// File is pyramid abstraction for an os.File
type File interface {
io.Reader
io.Writer
io.Closer
io.ReaderAt
Sync() error
Stat() (os.FileInfo, error)
}
// StoredFile is pyramid abstraction for an os.File with
// a Store operation that makes the file persistent
type StoredFile interface {
File
// Store - Successful operation guarantees that the file is persistent.
// If the file wasn't closed, Store closes it.
Store(ctx context.Context, filename string) error
// Abort removes all traces of the file from the filesystem.
// It's allowed to call Abort on the file at any stage, unless the file was already stored.
Abort(ctx context.Context) error
}