gorotator

README

gorotator

The small library for a file rotation. Zero dependencies, only standart library.

Quick start

package main

import (
	"fmt"
	"github.com/BoRuDar/gorotator"
)

func main() {
	fr, err := gorotator.New(gorotator.Config{
		PathToDir:        "./testdir",
		FileName:         "file.log",
		MaxFileSize:      1 * gorotator.KB,
		MaxNumberOfFiles: 3,
		IsWindows:        true,
	})
	if err != nil {
		panic(err)
	}
	defer fr.Close()

	_, err = fmt.Fprintln(fr, "test")
	if err != nil {
		panic(err)
	}
}

Documentation

Index

• Constants
• func New(cfg Config) (io.WriteCloser, error)
• type Config

Constants

const (
	KB int64 = 1024
	MB       = KB * 1024
	GB       = MB * 1024
)

Functions

func New

func New(cfg Config) (io.WriteCloser, error)

Types

type Config

type Config struct {
	FileName         string
	PathToDir        string
	MaxFileSize      int64 // in bytes
	MaxNumberOfFiles int
	IsWindows        bool
}