forked from cockroachdb/cockroach
-
Notifications
You must be signed in to change notification settings - Fork 0
/
byte_size.go
62 lines (53 loc) · 1.89 KB
/
byte_size.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
// Copyright 2017 The Cockroach Authors.
//
// 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 settings
import (
"github.com/pkg/errors"
"github.com/cockroachdb/cockroach/pkg/util/humanizeutil"
)
// ByteSizeSetting is the interface of a setting variable that will be
// updated automatically when the corresponding cluster-wide setting
// of type "bytesize" is updated.
type ByteSizeSetting struct {
IntSetting
}
var _ Setting = &ByteSizeSetting{}
// Typ returns the short (1 char) string denoting the type of setting.
func (*ByteSizeSetting) Typ() string {
return "z"
}
func (b *ByteSizeSetting) String(sv *Values) string {
return humanizeutil.IBytes(b.Get(sv))
}
// RegisterByteSizeSetting defines a new setting with type bytesize.
func RegisterByteSizeSetting(key, desc string, defaultValue int64) *ByteSizeSetting {
return RegisterValidatedByteSizeSetting(key, desc, defaultValue, nil)
}
// RegisterValidatedByteSizeSetting defines a new setting with type bytesize
// with a validation function.
func RegisterValidatedByteSizeSetting(
key, desc string, defaultValue int64, validateFn func(int64) error,
) *ByteSizeSetting {
if validateFn != nil {
if err := validateFn(defaultValue); err != nil {
panic(errors.Wrap(err, "invalid default"))
}
}
setting := &ByteSizeSetting{IntSetting{
defaultValue: defaultValue,
validateFn: validateFn,
}}
register(key, desc, setting)
return setting
}