uniquename

Documentation

Index

• Variables
• func ExtractTime(path string, opts Options) (time.Time, error)
• func SetRuntime(r Runtime) func()
• type Generator
  • func New(path string, opts Options) (*Generator, error)
  • func (g *Generator) Next() (path string, ok bool)
• type Options
• type Runtime

Variables

var DefaultOptions = Options{
	TimePrefixEnabled: true,
	TimePrefixLayout:  "2006-01-02T150405",
	TimePrefixSupportedLayouts: []string{
		"2006-01-02T150405-0700",
		"2006-01-02T150405",
	},
	BeforeExtension:    true,
	MaxExtensionLength: 10,
}

var DefaultRuntime = Runtime{
	Clock:   clockwork.NewRealClock(),
	Loc:     time.Local,
	RandInt: rand.Int31,
}

var ErrMissingTime = errors.New("missing timestamp")

Functions

func ExtractTime

func ExtractTime(path string, opts Options) (time.Time, error)

func SetRuntime

func SetRuntime(r Runtime) func()

Types

type Generator

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

func New

func New(path string, opts Options) (*Generator, error)

func (*Generator) Next

func (g *Generator) Next() (path string, ok bool)

type Options

type Options struct {
	// prepend current time to name, even for original name
	TimePrefixEnabled          bool
	TimePrefixLayout           string
	TimePrefixSupportedLayouts []string

	// if name contains an extension
	BeforeExtension    bool
	MaxExtensionLength int
}

type Runtime

type Runtime struct {
	Clock interface {
		Now() time.Time
	}
	Loc     *time.Location
	RandInt func() int32
}