snapshot

Documentation

Index

• func ValidateName(name string) error
• type Entry
• type Loaded
  • func Load(projectRoot, name string, configuredPaths []string) (Loaded, error)
• type Manifest
• type Result
  • func Restore(loaded Loaded) (Result, error)
  • func Save(plan SavePlan) (Result, error)
• type SavePlan
  • func PlanSave(projectRoot, name string, paths []string, noClobber bool) (SavePlan, error)

Functions

func ValidateName

func ValidateName(name string) error

Types

type Entry

type Entry struct {
	Path    string      `json:"path"`
	Present bool        `json:"present"`
	Kind    tree.Kind   `json:"kind,omitempty"`
	Nodes   []tree.Node `json:"nodes,omitempty"`
}

type Loaded

type Loaded struct {
	ProjectRoot string
	Name        string
	Directory   string
	Manifest    Manifest
	Present     int
	Absent      int
}

func Load

func Load(projectRoot, name string, configuredPaths []string) (Loaded, error)

type Manifest

type Manifest struct {
	Version int     `json:"version"`
	Name    string  `json:"name"`
	Entries []Entry `json:"entries"`
}

type Result

type Result struct {
	Saved    int
	Removed  int
	Restored int
	Absent   int
	Replaced bool
}

func Restore

func Restore(loaded Loaded) (Result, error)

func Save

func Save(plan SavePlan) (Result, error)

type SavePlan

type SavePlan struct {
	ProjectRoot string
	Name        string
	Paths       []string
	Entries     []Entry
	Exists      bool
	Present     int
	Absent      int
}

func PlanSave

func PlanSave(projectRoot, name string, paths []string, noClobber bool) (SavePlan, error)