restic/backend/interface.go

74 lines
1.7 KiB
Go
Raw Normal View History

2014-09-23 20:39:12 +00:00
package backend
2015-03-28 10:50:23 +00:00
import "io"
2014-10-07 21:19:26 +00:00
2015-03-28 10:50:23 +00:00
// Type is the type of a Blob.
2014-09-23 20:39:12 +00:00
type Type string
const (
Data Type = "data"
2014-09-23 20:39:12 +00:00
Key = "key"
Lock = "lock"
Snapshot = "snapshot"
Tree = "tree"
)
2014-10-04 14:49:39 +00:00
const (
2015-03-28 10:50:23 +00:00
Version = 1
2014-10-04 14:49:39 +00:00
)
2015-03-28 10:50:23 +00:00
// A Backend manages blobs of data.
type Backend interface {
// Location returns a string that specifies the location of the repository,
// like a URL.
Location() string
2014-10-07 21:19:26 +00:00
2015-03-28 10:50:23 +00:00
// Create creates a new Blob. The data is available only after Finalize()
// has been called on the returned Blob.
Create() (Blob, error)
2015-03-28 10:50:23 +00:00
// Get returns an io.ReadCloser for the Blob with the given name of type t.
Get(t Type, name string) (io.ReadCloser, error)
2015-03-28 10:50:23 +00:00
// Test a boolean value whether a Blob with the name and type exists.
Test(t Type, name string) (bool, error)
2014-12-21 14:57:41 +00:00
2015-03-28 10:50:23 +00:00
// Remove removes a Blob with type t and name.
Remove(t Type, name string) error
2014-12-21 14:57:41 +00:00
2015-03-28 10:50:23 +00:00
// Close the backend
Close() error
Identifier
Lister
2014-12-21 14:57:41 +00:00
}
2015-03-28 10:50:23 +00:00
type Identifier interface {
// ID returns a unique ID for a specific repository. This means restic can
// recognize repositories accessed via different methods (e.g. local file
// access and sftp).
ID() string
2014-12-21 14:57:41 +00:00
}
2014-09-23 20:39:12 +00:00
2015-03-28 10:50:23 +00:00
type Lister interface {
// List returns a channel that yields all names of blobs of type t in
// lexicographic order. A goroutine is started for this. If the channel
// done is closed, sending stops.
List(t Type, done <-chan struct{}) <-chan string
2014-12-21 14:57:41 +00:00
}
2014-10-04 17:20:15 +00:00
2014-12-21 16:02:49 +00:00
type Deleter interface {
2015-03-28 10:50:23 +00:00
// Delete the complete repository.
2014-12-21 14:57:41 +00:00
Delete() error
}
2015-03-28 10:50:23 +00:00
type Blob interface {
io.Writer
2014-12-21 14:57:41 +00:00
2015-03-28 10:50:23 +00:00
// Finalize moves the data blob to the final location for type and name.
Finalize(t Type, name string) error
2015-03-28 10:50:23 +00:00
// Size returns the number of bytes written to the backend so far.
Size() uint
2014-12-21 14:57:41 +00:00
}