snapshot

package

v0.2.0 Latest Latest Go to latest Published: Feb 11, 2026 License: MIT Imports: 14 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/majorcontext/moat

Links

Open Source Insights

Documentation ¶

Rendered for

Overview ¶

Package snapshot provides types and interfaces for workspace snapshots.

Index ¶

Variables
func IsAPFS(path string) bool
func NewID() string
type APFSBackend
- func NewAPFSBackend(snapshotDir string) *APFSBackend
type ArchiveBackend
- func NewArchiveBackend(snapshotDir string, opts ArchiveOptions) *ArchiveBackend
type ArchiveOptions
type Backend
type Engine
- func NewEngine(workspace, snapshotDir string, opts EngineOptions) (*Engine, error)
type EngineOptions
type Metadata
type Type
- func (t Type) String() string

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrAPFSNotAvailable = fmt.Errorf("APFS snapshots are only available on macOS")

ErrAPFSNotAvailable is returned when APFS operations are attempted on non-Darwin platforms.

Functions ¶

func IsAPFS ¶

func IsAPFS(path string) bool

IsAPFS returns false on non-darwin platforms.

func NewID ¶

func NewID() string

NewID generates a new snapshot ID using id.Generate with the "snap" prefix, producing values like "snap_a1b2c3d4e5f6" (12-character hex suffix).

Types ¶

type APFSBackend ¶

type APFSBackend struct {
	// contains filtered or unexported fields
}

APFSBackend is a stub for non-darwin platforms. On non-darwin systems, all methods return errors to indicate APFS is unavailable.

func NewAPFSBackend ¶

func NewAPFSBackend(snapshotDir string) *APFSBackend

NewAPFSBackend returns a stub APFSBackend on non-darwin platforms. The snapshotDir parameter is accepted for API compatibility but not used.

func (*APFSBackend) Create ¶

func (b *APFSBackend) Create(workspacePath, id string) (string, error)

Create returns an error on non-darwin platforms.

func (*APFSBackend) Delete ¶

func (b *APFSBackend) Delete(nativeRef string) error

Delete returns an error on non-darwin platforms.

func (*APFSBackend) List ¶

func (b *APFSBackend) List(workspacePath string) ([]string, error)

List returns an error on non-darwin platforms.

func (*APFSBackend) Name ¶

func (b *APFSBackend) Name() string

Name returns the backend identifier.

func (*APFSBackend) Restore ¶

func (b *APFSBackend) Restore(workspacePath, nativeRef string) error

Restore returns an error on non-darwin platforms.

func (*APFSBackend) RestoreTo ¶

func (b *APFSBackend) RestoreTo(nativeRef, destPath string) error

RestoreTo returns an error on non-darwin platforms.

type ArchiveBackend ¶

type ArchiveBackend struct {
	// contains filtered or unexported fields
}

ArchiveBackend implements the Backend interface using tar.gz archives.

func NewArchiveBackend ¶

func NewArchiveBackend(snapshotDir string, opts ArchiveOptions) *ArchiveBackend

NewArchiveBackend creates a new archive-based snapshot backend.

func (*ArchiveBackend) Create ¶

func (b *ArchiveBackend) Create(workspacePath, id string) (string, error)

Create creates a tar.gz archive of the workspace.

func (*ArchiveBackend) Delete ¶

func (b *ArchiveBackend) Delete(nativeRef string) error

Delete removes the archive file.

func (*ArchiveBackend) List ¶

func (b *ArchiveBackend) List(_ string) ([]string, error)

List returns all archive files in the snapshot directory. The workspacePath parameter is unused but required by the Backend interface.

func (*ArchiveBackend) Name ¶

func (b *ArchiveBackend) Name() string

Name returns the backend identifier.

func (*ArchiveBackend) Restore ¶

func (b *ArchiveBackend) Restore(workspacePath, nativeRef string) error

Restore extracts the archive to the workspace, preserving .git directory.

func (*ArchiveBackend) RestoreTo ¶

func (b *ArchiveBackend) RestoreTo(nativeRef, destPath string) error

RestoreTo extracts the archive to an arbitrary destination path.

type ArchiveOptions ¶

type ArchiveOptions struct {
	// UseGitignore enables parsing .gitignore files to exclude matching paths.
	UseGitignore bool
	// Additional specifies extra patterns to exclude (gitignore syntax).
	Additional []string
}

ArchiveOptions configures the archive backend behavior.

type Backend ¶

type Backend interface {
	// Name returns the backend identifier (e.g., "apfs", "zfs", "archive").
	Name() string

	// Create creates a snapshot of the workspace and returns its native reference.
	Create(workspacePath string, id string) (nativeRef string, err error)

	// Restore restores a snapshot to the workspace (in-place).
	Restore(workspacePath string, nativeRef string) error

	// RestoreTo restores a snapshot to a different directory.
	RestoreTo(nativeRef string, destPath string) error

	// Delete removes a snapshot.
	Delete(nativeRef string) error

	// List returns all snapshots for a workspace.
	List(workspacePath string) ([]string, error)
}

Backend defines the interface for snapshot storage backends.

type Engine ¶

type Engine struct {
	// contains filtered or unexported fields
}

Engine manages snapshot operations with automatic backend detection.

func NewEngine ¶

func NewEngine(workspace, snapshotDir string, opts EngineOptions) (*Engine, error)

NewEngine creates a new snapshot engine with automatic backend detection. It loads any existing snapshot metadata from the snapshot directory.

func (*Engine) Backend ¶

func (e *Engine) Backend() Backend

Backend returns the detected backend.

func (*Engine) Create ¶

func (e *Engine) Create(typ Type, label string) (Metadata, error)

Create creates a new snapshot with the given type and label.

func (*Engine) Delete ¶

func (e *Engine) Delete(id string) error

Delete removes a snapshot and its metadata.

func (*Engine) Get ¶

func (e *Engine) Get(id string) (Metadata, bool)

Get returns a snapshot by ID.

func (*Engine) List ¶

func (e *Engine) List() ([]Metadata, error)

List returns all snapshots sorted by creation time (newest first).

func (*Engine) Restore ¶

func (e *Engine) Restore(id string) error

Restore restores a snapshot in-place to the workspace.

func (*Engine) RestoreTo ¶

func (e *Engine) RestoreTo(id, destPath string) error

RestoreTo restores a snapshot to a different directory.

type EngineOptions ¶

type EngineOptions struct {
	// UseGitignore enables parsing .gitignore files to exclude matching paths.
	UseGitignore bool
	// Additional specifies extra patterns to exclude (gitignore syntax).
	Additional []string
	// ForceBackend forces a specific backend for testing: "archive" or "apfs".
	ForceBackend string
}

EngineOptions configures the snapshot engine behavior.

type Metadata ¶

type Metadata struct {
	ID        string    `json:"id"`
	Type      Type      `json:"type"`
	Label     string    `json:"label,omitempty"`
	Backend   string    `json:"backend"`
	CreatedAt time.Time `json:"created_at"`
	SizeDelta *int64    `json:"size_delta,omitempty"`
	NativeRef string    `json:"native_ref,omitempty"`
}

Metadata describes a snapshot.

type Type ¶

type Type string

Type represents the trigger type for a snapshot.

const (
	TypePreRun Type = "pre-run"
	TypeGit    Type = "git"
	TypeBuild  Type = "build"
	TypeIdle   Type = "idle"
	TypeManual Type = "manual"
	TypeSafety Type = "safety"
)

func (Type) String ¶

func (t Type) String() string

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL