versioner

Documentation

Overview

Package versioner implements common interfaces for file versioning and a simple default versioning scheme.

Index

• Constants
• Variables
• func TagFilename(name, tag string) string
• func UntagFilename(path string) (string, string)
• type FileVersion
• type Versioner
  • func New(cfg config.FolderConfiguration) (Versioner, error)

Constants

const (
	DefaultPath = ".stversions"
)

const (
	TimeFormat = "20060102-150405"
)

Variables

var (
	ErrDirectory = errors.New("cannot restore on top of a directory")
)

var ErrRestorationNotSupported = errors.New("version restoration not supported with the current versioner")

Functions

func TagFilename

func TagFilename(name, tag string) string

TagFilename inserts ~tag just before the extension of the filename.

func UntagFilename

func UntagFilename(path string) (string, string)

UntagFilename returns the filename without tag, and the extracted tag

Types

type FileVersion

type FileVersion struct {
	VersionTime time.Time `json:"versionTime"`
	ModTime     time.Time `json:"modTime"`
	Size        int64     `json:"size"`
}

type Versioner

type Versioner interface {
	Archive(filePath string) error
	GetVersions() (map[string][]FileVersion, error)
	Restore(filePath string, versionTime time.Time) error
	Clean(context.Context) error
}

func New

func New(cfg config.FolderConfiguration) (Versioner, error)