tarsnap

type Archive struct {
	Name    string    `json:"name"`              // base.tag
	Base    string    `json:"base,omitempty"`    // base alone
	Tag     string    `json:"tag,omitempty"`     // .tag alone
	Created time.Time `json:"created,omitempty"` // in UTC
}

type Archives []Archive

type Config struct {
	Tool     string `json:"tool"`
	Keyfile  string `json:"keyFile"`
	WorkDir  string `json:"workDir"`
	CacheDir string `json:"cacheDir"`

	// Optional settings flags to pass to the tarsnap command-line tool.
	Flags []Flag `json:"flags"`

	// If not nil, this function is called with each tarsnap command-line giving
	// the full argument list.
	CmdLog func(cmd string, args []string) `json:"-" yaml:"-"`
}

type CreateOptions struct {
	// Include these files or directories in the archive.
	// N.B. The tarsnap tool does not expand globs in include paths.
	Include []string `json:"include"`

	// Change to this directory before adding entries.
	WorkDir string `json:"workDir,omitempty"`

	// Modify names by these patterns, /old/new/[gps].
	Modify []string `json:"modify,omitempty"`

	// Exclude files or directories matching these glob patterns.
	Exclude []string `json:"exclude,omitempty"`

	// Follow symlinks (as tarsnap -H), storing the target rather than the link.
	FollowSymlinks bool `json:"followSymlinks" yaml:"follow-symlinks"`

	// Store access times (as tarsnap --store-atime). Not advised.
	StoreAccessTime bool `json:"storeAccessTime" yaml:"store-access-time"`

	// Preserve original pathnames (as tarsnap -P).
	PreservePaths bool `json:"preservePaths" yaml:"preserve-paths"`

	// If non-zero, set the creation time of the archive to this time.
	CreationTime time.Time `json:"creationTime,omitempty" yaml:"creation-time"`

	// Simulate creating archives rather than creating them.
	DryRun bool `json:"dryRun,omitempty" yaml:"dry-run"`
}

type Entry struct {
	Mode         os.FileMode
	Owner, Group int
	Size         int64     // in bytes
	ModTime      time.Time // in UTC
	Name         string
}

type ExtractOptions struct {
	// Include files matching these globs in the output.  If this is empty, the
	// whole archive is extracted except for any exclusions. If not, only the
	// files or directories specified are extracted, modulo exclusions.
	Include []string `json:"include"`

	// Exclude files or directories matching these patterns.
	Exclude []string `json:"exclude,omitempty"`

	// Change to this directory before extracting entries.
	WorkDir string `json:"workDir,omitempty"`

	// Restore permissions, owner, flags, and ACL.
	RestorePermissions bool `json:"restorePerms" yaml:"restore-perms"`

	// Ignore owner and group settings from the archive.
	IgnoreOwners bool `json:"ignoreOwners" yaml:"ignore-owners"`

	// Stop reading after the first match for each included path.
	FastRead bool `json:"fastRead" yaml:"fast-read"`

	// Resume an incomplete previous extraction, skipping files that already
	// match by size and timestamp in the destination.
	Resume bool `json:"resume" yaml:"resume"`
}

type Flag struct {
	Match string // if non-empty, only add if this argument is present
	Flag  string // the name of the flag, passed as --name

	// If not nil, the value of a flag must be a string, float64, or bool.
	// A string value will have environment variables ($VAR) expanded.
	//
	// If value is nil or true, the flag has no argument: --name
	// If value is false, the flag is sent as: --no-name
	// Otherwise the flag is sent as: --name value
	Value interface{}
}

type RC map[string]string

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

type SizeInfo struct {
	All     *Sizes            // sizes for all archives known
	Archive map[string]*Sizes // sizes for individual archives
}

type Sizes struct {
	// Total bytes of original input
	InputBytes int64 `json:"inputBytes"`
	// Size after input compression
	CompressedBytes int64 `json:"compressedBytes"`
	// Size after deduplication
	UniqueBytes int64 `json:"uniqueBytes"`
	// Size after deduplication and compression
	CompressedUniqueBytes int64 `json:"compressedUniqueBytes"`
}