versioner

Documentation

Overview

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

Index

• Constants
• Variables
• func ExtractTag(path string) string
• func TagFilename(name, tag string) string
• func UntagFilename(path string) (string, string)
• type External
  • func (v External) Archive(filePath string) error
  • func (v External) GetVersions() (map[string][]FileVersion, error)
  • func (v External) Restore(filePath string, versionTime time.Time) error
• type FileVersion
• type Interval
• type Simple
  • func (v Simple) Archive(filePath string) error
  • func (v Simple) GetVersions() (map[string][]FileVersion, error)
  • func (v Simple) Restore(filepath string, versionTime time.Time) error
• type Staggered
  • func (v *Staggered) Archive(filePath string) error
  • func (v *Staggered) GetVersions() (map[string][]FileVersion, error)
  • func (v *Staggered) Restore(filepath string, versionTime time.Time) error
• type Trashcan
  • func (t *Trashcan) Archive(filePath string) error
  • func (t *Trashcan) GetVersions() (map[string][]FileVersion, error)
  • func (t *Trashcan) Restore(filepath string, versionTime time.Time) error
  • func (t *Trashcan) String() string
• type Versioner
  • func NewExternal(folderID string, filesystem fs.Filesystem, params map[string]string) Versioner
  • func NewSimple(folderID string, folderFs fs.Filesystem, params map[string]string) Versioner
  • func NewStaggered(folderID string, folderFs fs.Filesystem, params map[string]string) Versioner
  • func NewTrashcan(folderID string, folderFs fs.Filesystem, params map[string]string) Versioner

Constants

const (
	TimeFormat = "20060102-150405"
	TimeGlob   = "[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9]-[0-9][0-9][0-9][0-9][0-9][0-9]" // glob pattern matching TimeFormat
)

Variables

var ErrRestorationNotSupported = fmt.Errorf("version restoration not supported with the current versioner")

var Factories = map[string]func(folderID string, filesystem fs.Filesystem, params map[string]string) Versioner{}

Functions

func ExtractTag

func ExtractTag(path string) string

Returns the tag from a filename, whether at the end or middle.

func TagFilename

func TagFilename(name, tag string) string

Inserts ~tag just before the extension of the filename.

func UntagFilename

func UntagFilename(path string) (string, string)

Types

type External

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

func (External) Archive

func (v External) Archive(filePath string) error

Archive moves the named file away to a version archive. If this function returns nil, the named file does not exist any more (has been archived).

func (External) GetVersions

func (v External) GetVersions() (map[string][]FileVersion, error)

func (External) Restore

func (v External) Restore(filePath string, versionTime time.Time) error

type FileVersion

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

type Interval

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

type Simple

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

func (Simple) Archive

func (v Simple) Archive(filePath string) error

Archive moves the named file away to a version archive. If this function returns nil, the named file does not exist any more (has been archived).

func (Simple) GetVersions

func (v Simple) GetVersions() (map[string][]FileVersion, error)

func (Simple) Restore

func (v Simple) Restore(filepath string, versionTime time.Time) error

type Staggered

type Staggered struct {
	suture.Service
	// contains filtered or unexported fields
}

func (*Staggered) Archive

func (v *Staggered) Archive(filePath string) error

Archive moves the named file away to a version archive. If this function returns nil, the named file does not exist any more (has been archived).

func (*Staggered) GetVersions

func (v *Staggered) GetVersions() (map[string][]FileVersion, error)

func (*Staggered) Restore

func (v *Staggered) Restore(filepath string, versionTime time.Time) error

type Trashcan

type Trashcan struct {
	suture.Service
	// contains filtered or unexported fields
}

func (*Trashcan) Archive

func (t *Trashcan) Archive(filePath string) error

Archive moves the named file away to a version archive. If this function returns nil, the named file does not exist any more (has been archived).

func (*Trashcan) GetVersions

func (t *Trashcan) GetVersions() (map[string][]FileVersion, error)

func (*Trashcan) Restore

func (t *Trashcan) Restore(filepath string, versionTime time.Time) error

func (*Trashcan) String

func (t *Trashcan) String() string

type Versioner

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

func NewExternal

func NewExternal(folderID string, filesystem fs.Filesystem, params map[string]string) Versioner

func NewSimple

func NewSimple(folderID string, folderFs fs.Filesystem, params map[string]string) Versioner

func NewStaggered

func NewStaggered(folderID string, folderFs fs.Filesystem, params map[string]string) Versioner

func NewTrashcan

func NewTrashcan(folderID string, folderFs fs.Filesystem, params map[string]string) Versioner