78 lines
4.2 KiB
Go
78 lines
4.2 KiB
Go
package interfaces
|
|
|
|
import (
|
|
"context"
|
|
"io"
|
|
|
|
"gitea.unprism.ru/KRBL/Agate/store"
|
|
)
|
|
|
|
// SnapshotManager is an interface that defines operations for managing and interacting with snapshots.
|
|
type SnapshotManager interface {
|
|
// CreateSnapshot creates a new snapshot from the specified source directory, associating it with a given name and parent ID.
|
|
// Returns the created Snapshot with its metadata or an error if the process fails.
|
|
CreateSnapshot(ctx context.Context, sourceDir string, name string, parentID string) (*store.Snapshot, error)
|
|
|
|
// CreateSnapshotAsync initiates a background process to create a snapshot.
|
|
// Returns the job ID (which is also the snapshot ID) or an error if the process couldn't start.
|
|
// onStart is called in the background goroutine before the snapshot creation starts.
|
|
// onFinish is called in the background goroutine after the snapshot creation finishes (successfully or with error).
|
|
CreateSnapshotAsync(ctx context.Context, sourceDir string, name string, parentID string, onStart func(), onFinish func(string, error)) (string, error)
|
|
|
|
// GetSnapshotStatus retrieves the status of an asynchronous snapshot creation job.
|
|
GetSnapshotStatus(ctx context.Context, jobID string) (*store.SnapshotStatus, error)
|
|
|
|
// GetSnapshotDetails retrieves detailed metadata for a specific snapshot identified by its unique snapshotID.
|
|
// Returns a Snapshot object containing metadata
|
|
GetSnapshotDetails(ctx context.Context, snapshotID string) (*store.Snapshot, error)
|
|
|
|
// ListSnapshots retrieves a list of available snapshots with filtering and pagination options.
|
|
ListSnapshots(ctx context.Context, opts store.ListOptions) ([]store.SnapshotInfo, error)
|
|
|
|
// DeleteSnapshot removes a snapshot identified by snapshotID. Returns an error if the snapshot does not exist or cannot be deleted.
|
|
DeleteSnapshot(ctx context.Context, snapshotID string) error
|
|
|
|
// OpenFile retrieves and opens a file from the specified snapshot, returning a readable stream and an error, if any.
|
|
OpenFile(ctx context.Context, snapshotID string, filePath string) (io.ReadCloser, error)
|
|
|
|
// ExtractSnapshot extracts the contents of a specified snapshot to a target directory at the given path.
|
|
// If cleanTarget is true, the target directory will be cleaned before extraction.
|
|
// Returns an error if the snapshot ID is invalid or the extraction fails.
|
|
ExtractSnapshot(ctx context.Context, snapshotID string, path string, cleanTarget bool) error
|
|
|
|
// UpdateSnapshotMetadata updates the metadata of an existing snapshot, allowing changes to its name.
|
|
UpdateSnapshotMetadata(ctx context.Context, snapshotID string, newName string) error
|
|
|
|
// StreamSnapshotDiff creates and streams a differential archive between two snapshots.
|
|
// It returns an io.ReadCloser for the archive stream and an error.
|
|
// The caller is responsible for closing the reader, which will also handle cleanup of temporary resources.
|
|
StreamSnapshotDiff(ctx context.Context, snapshotID, parentID string, offset int64) (io.ReadCloser, error)
|
|
|
|
// GetSnapshotDiffInfo calculates the hash and size of a differential archive between two snapshots.
|
|
GetSnapshotDiffInfo(ctx context.Context, snapshotID, parentID string) (*store.DiffInfo, error)
|
|
}
|
|
|
|
// SnapshotServer defines the interface for a server that can share snapshots
|
|
type SnapshotServer interface {
|
|
// Start initializes and begins the server's operation, handling incoming requests or processes within the provided context.
|
|
Start(ctx context.Context) error
|
|
|
|
// Stop gracefully shuts down the server, releasing any allocated resources and ensuring all operations are completed.
|
|
Stop(ctx context.Context) error
|
|
}
|
|
|
|
// SnapshotClient defines the interface for a client that can connect to a server and download snapshots
|
|
type SnapshotClient interface {
|
|
// ListSnapshots retrieves a list of snapshots from the server
|
|
ListSnapshots(ctx context.Context) ([]store.SnapshotInfo, error)
|
|
|
|
// FetchSnapshotDetails retrieves detailed information about a specific snapshot
|
|
FetchSnapshotDetails(ctx context.Context, snapshotID string) (*store.Snapshot, error)
|
|
|
|
// DownloadSnapshotDiff downloads a differential archive between two snapshots to a target directory
|
|
DownloadSnapshotDiff(ctx context.Context, snapshotID, localParentID, targetPath string) error
|
|
|
|
// Close closes the connection to the server
|
|
Close() error
|
|
}
|