fs_snapshot

type BackupConfig struct {
	ProviderID string

	Timeout time.Duration

	// Simple - try to do it as simple as possible, but not simpler.
	// In Windows this means do not use VSS Writers.
	Simple bool

	// If set, overrides the info callback from the snapshoter
	InfoCallback InfoMessageCallback
}

type Backuper interface {
	// TryToCreateTemporarySnapshot returns the snapshoted directory volume if a snapshot could be made,
	// or the original directory otherwise.
	// If the directory is not yet available as a snapshot, a snapshot is created.
	// If the directory is inside an existing snapshot, the snapshot is re-used.
	// An error is returned iff some problem occurred while creating the snapshot, but not
	// if the directory does not support snapshots.
	TryToCreateTemporarySnapshot(directory string) (string, *Snapshot, error)

	// Close frees all resources.
	Close()
}

type ConnectionType int

type InfoMessageCallback func(level MessageLevel, format string, a ...interface{})

type MessageLevel int

type Provider struct {
	ID      string
	Name    string
	Version string
	Type    string
}

type ServerConfig struct {
	// IP to listen on. Use "0.0.0.0" to listen on all interfaces. Default is "localhost".
	IP string

	// Port to listen on.
	Port int

	// InactivityTime to stop the server, if this is > 0.
	InactivityTime time.Duration

	InfoCallback InfoMessageCallback
}

type Snapshot struct {
	ID           string
	OriginalDir  string
	SnapshotDir  string
	CreationTime time.Time
	Set          *SnapshotSet
	Provider     *Provider
	State        string
	Attributes   string
}

type SnapshotSet struct {
	ID                      string
	CreationTime            time.Time
	SnapshotCountOnCreation int
	Snapshots               []*Snapshot
}

type Snapshoter interface {
	// ListProviders list all provider available
	// filterID: filter by id if != ""
	ListProviders(filterID string) ([]*Provider, error)

	// ListSets list all snapshot sets available
	// filterID: filter by id if != ""
	ListSets(filterID string) ([]*SnapshotSet, error)

	// ListSnapshots list all snapshots available
	// filterID: filter by id if != ""
	ListSnapshots(filterID string) ([]*Snapshot, error)

	// SimplifyID simplifies the snapshot, set and provider IDs, if possible
	SimplifyID(id string) string

	// DeleteSet deletes one snapshot set and all its snapshots.
	// Returns true if snapshot was found and deleted, false if it was not found and an
	// error if something went wrong.
	DeleteSet(id string, force bool) (bool, error)

	// DeleteSnapshot deletes one snapshot
	// Returns true if snapshot was found and deleted, false if it was not found and an
	// error if something went wrong.
	DeleteSnapshot(id string, force bool) (bool, error)

	// ListMountPoints lists all mount points inside a volume.
	ListMountPoints(volume string) ([]string, error)

	// StartBackup creates a Backuper to allow easy backup creation.
	StartBackup(cfg *BackupConfig) (Backuper, error)

	// Close frees all resources.
	Close()
}

type SnapshoterConfig struct {
	ConnectionType ConnectionType
	ServerIP       string
	ServerPort     int
	InfoCallback   InfoMessageCallback
}