-
Notifications
You must be signed in to change notification settings - Fork 3
/
option.go
120 lines (103 loc) · 3.01 KB
/
option.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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
// Copyright 2020 FishGoddess. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package cachego
import (
"context"
"math/bits"
"time"
)
// Option is a function which initializes config.
type Option func(conf *config)
// applyOptions applies opts to conf.
func applyOptions(conf *config, opts []Option) *config {
for _, opt := range opts {
opt(conf)
}
return conf
}
// WithMapSize is an option setting initializing map size of cache.
func WithMapSize(mapSize uint) Option {
return func(conf *config) {
conf.mapSize = int(mapSize)
}
}
// WithSegmentSize is an option setting initializing segment size of cache.
// segmentSize must be the pow of 2 (such as 64) or the segments may be uneven.
func WithSegmentSize(segmentSize uint) Option {
if bits.OnesCount(segmentSize) > 1 {
panic("cachego: segmentSize must be the pow of 2 (such as 64) or the segments may be uneven.")
}
return func(conf *config) {
conf.segmentSize = int(segmentSize)
}
}
// WithAutoGC is an option turning on automatically gc.
func WithAutoGC(d time.Duration) Option {
return func(conf *config) {
if d > 0 {
conf.gcDuration = d
}
}
}
// WithDisableSingleflight is an option disabling single-flight mode of cache.
func WithDisableSingleflight() Option {
return func(conf *config) {
conf.singleflight = false
}
}
// OpOption is a function which initializes opConfig.
type OpOption func(conf *opConfig)
// applyOpOptions applies opts to conf.
func applyOpOptions(conf *opConfig, opts []OpOption) *opConfig {
for _, opt := range opts {
opt(conf)
}
return conf
}
// WithOpContext sets context to ctx.
func WithOpContext(ctx context.Context) OpOption {
return func(conf *opConfig) {
conf.ctx = ctx
}
}
// WithOpTTL sets the ttl of missed key if loaded to ttl.
func WithOpTTL(ttl time.Duration) OpOption {
return func(conf *opConfig) {
conf.ttl = ttl
}
}
// WithOpNoTTL sets the ttl of missed key to no ttl.
func WithOpNoTTL() OpOption {
return func(conf *opConfig) {
conf.ttl = noTTL
}
}
// WithOpOnMissed sets onMissed to Get operation.
func WithOpOnMissed(onMissed func(ctx context.Context) (data interface{}, err error)) OpOption {
return func(conf *opConfig) {
conf.onMissed = onMissed
}
}
// WithOpDisableSingleflight sets the single-flight mode to false.
func WithOpDisableSingleflight() OpOption {
return func(conf *opConfig) {
conf.singleflight = false
}
}
// WithOpDisableReload sets the reloading flag to false.
func WithOpDisableReload() OpOption {
return func(conf *opConfig) {
conf.reload = false
}
}