rotatefile

Documentation

Index

• type EmptyRotateFilerOption
• type RotateFiler
  • func NewRotateFiler(filedir string, options ...RotateFilerOption) (*RotateFiler, error)
  • func (o *RotateFiler) ApplyOptions(options ...RotateFilerOption) *RotateFiler
  • func (f *RotateFiler) Write(p []byte) (file *os.File, n int, err error)
• type RotateFilerOption
  • func WithFileTimeLayout(fileTimeLayout string) RotateFilerOption
  • func WithMaxAge(maxAge time.Duration) RotateFilerOption
  • func WithMaxCount(maxCount int64) RotateFilerOption
  • func WithPrefixName(prefixName string) RotateFilerOption
  • func WithRotateInterval(rotateInterval time.Duration) RotateFilerOption
  • func WithRotateSize(rotateSize int64) RotateFilerOption
  • func WithSuffixName(subfixName string) RotateFilerOption
• type RotateFilerOptionFunc

Types

type EmptyRotateFilerOption

type EmptyRotateFilerOption struct{}

EmptyRotateFilerOption does not alter the configuration. It can be embedded in another structure to build custom options.

This API is EXPERIMENTAL.

type RotateFiler

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

func NewRotateFiler

func NewRotateFiler(filedir string, options ...RotateFilerOption) (*RotateFiler, error)

func (*RotateFiler) ApplyOptions

func (o *RotateFiler) ApplyOptions(options ...RotateFilerOption) *RotateFiler

func (*RotateFiler) Write

func (f *RotateFiler) Write(p []byte) (file *os.File, n int, err error)

type RotateFilerOption

type RotateFilerOption interface {
	// contains filtered or unexported methods
}

A RotateFilerOption sets options.

func WithFileTimeLayout

func WithFileTimeLayout(fileTimeLayout string) RotateFilerOption

func WithMaxAge

func WithMaxAge(maxAge time.Duration) RotateFilerOption

func WithMaxCount

func WithMaxCount(maxCount int64) RotateFilerOption

func WithPrefixName

func WithPrefixName(prefixName string) RotateFilerOption

func WithRotateInterval

func WithRotateInterval(rotateInterval time.Duration) RotateFilerOption

func WithRotateSize

func WithRotateSize(rotateSize int64) RotateFilerOption

func WithSuffixName

func WithSuffixName(subfixName string) RotateFilerOption

type RotateFilerOptionFunc

type RotateFilerOptionFunc func(*RotateFiler)

RotateFilerOptionFunc wraps a function that modifies Client into an implementation of the RotateFilerOption interface.