forked from lestrrat-go/file-rotatelogs
/
interface.go
46 lines (39 loc) · 1.1 KB
/
interface.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
package rotatelogs
import (
"os"
"sync"
"time"
)
// RotateLogs represents a log file that gets
// automatically rotated as you write to it.
type RotateLogs struct {
clock Clock
curFn string
globPattern string
linkName string
maxAge time.Duration
mutex sync.RWMutex
outFh *os.File
pattern string
rotationTime time.Duration
}
// Clock is the interface used by the RotateLogs
// object to determine the current time
type Clock interface {
Now() time.Time
}
type clockFn func() time.Time
// UTC is an object satisfying the Clock interface, which
// returns the current time in UTC
var UTC = clockFn(func() time.Time { return time.Now().UTC() })
// Local is an object satisfying the Clock interface, which
// returns the current time in the local timezone
var Local = clockFn(time.Now)
// Option is used to pass optional arguments to
// the RotateLogs constructor
type Option interface {
Configure(*RotateLogs) error
}
// OptionFn is a type of Option that is represented
// by a single function that gets called for Configure()
type OptionFn func(*RotateLogs) error