versioner

Documentation

Overview

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

Index

• Constants
• Variables
• type External
  • func (v External) Archive(filePath string) error
• type Interval
• type Simple
  • func (v Simple) Archive(filePath string) error
• type Staggered
  • func (v Staggered) Archive(filePath string) error
• type Versioner
  • func NewExternal(folderID, folderPath string, params map[string]string) Versioner
  • func NewSimple(folderID, folderPath string, params map[string]string) Versioner
  • func NewStaggered(folderID, folderPath string, 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 Factories = map[string]func(folderID string, folderDir string, params map[string]string) Versioner{}

Types

type External

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

The type holds our configuration

func (External) Archive

func (v External) Archive(filePath string) error

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

type Interval

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

type Simple

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

The type holds our configuration

func (Simple) Archive

func (v Simple) Archive(filePath string) error

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

type Staggered

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

The type holds our configuration

func (Staggered) Archive

func (v Staggered) Archive(filePath string) error

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

type Versioner

type Versioner interface {
	Archive(filePath string) error
}

func NewExternal

func NewExternal(folderID, folderPath string, params map[string]string) Versioner

The constructor function takes a map of parameters and creates the type.

func NewSimple

func NewSimple(folderID, folderPath string, params map[string]string) Versioner

The constructor function takes a map of parameters and creates the type.

func NewStaggered

func NewStaggered(folderID, folderPath string, params map[string]string) Versioner

The constructor function takes a map of parameters and creates the type.