-
Notifications
You must be signed in to change notification settings - Fork 24
/
dynstring.go
86 lines (74 loc) · 2.65 KB
/
dynstring.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
// Copyright 2015 Michal Witkowski. All Rights Reserved.
// See LICENSE for licensing terms.
package flagz
import (
"fmt"
"regexp"
"sync/atomic"
"unsafe"
flag "github.com/spf13/pflag"
)
// DynString creates a `Flag` that represents `string` which is safe to change dynamically at runtime.
func DynString(flagSet *flag.FlagSet, name string, value string, usage string) *DynStringValue {
dynValue := &DynStringValue{ptr: unsafe.Pointer(&value)}
flag := flagSet.VarPF(dynValue, name, "", usage)
MarkFlagDynamic(flag)
return dynValue
}
// DynStringValue is a flag-related `time.Duration` value wrapper.
type DynStringValue struct {
ptr unsafe.Pointer
validator func(string) error
notifier func(oldValue string, newValue string)
}
// Get retrieves the value in a thread-safe manner.
func (d *DynStringValue) Get() string {
p := (*string)(atomic.LoadPointer(&d.ptr))
return *p
}
// Set updates the value from a string representation in a thread-safe manner.
// This operation may return an error if the provided `input` doesn't parse, or the resulting value doesn't pass an
// optional validator.
// If a notifier is set on the value, it will be invoked in a separate go-routine.
func (d *DynStringValue) Set(val string) error {
if d.validator != nil {
if err := d.validator(val); err != nil {
return err
}
}
oldPtr := atomic.SwapPointer(&d.ptr, unsafe.Pointer(&val))
if d.notifier != nil {
go d.notifier(*(*string)(oldPtr), val)
}
return nil
}
// WithValidator adds a function that checks values before they're set.
// Any error returned by the validator will lead to the value being rejected.
// Validators are executed on the same go-routine as the call to `Set`.
func (d *DynStringValue) WithValidator(validator func(string) error) *DynStringValue {
d.validator = validator
return d
}
// WithNotifier adds a function is called every time a new value is successfully set.
// Each notifier is executed in a new go-routine.
func (d *DynStringValue) WithNotifier(notifier func(oldValue string, newValue string)) *DynStringValue {
d.notifier = notifier
return d
}
// Type is an indicator of what this flag represents.
func (d *DynStringValue) Type() string {
return "dyn_string"
}
// String represents the canonical representation of the type.
func (d *DynStringValue) String() string {
return fmt.Sprintf("%v", d.Get())
}
// ValidateDynStringMatchesRegex returns a validator function that checks all flag's values against regex.
func ValidateDynStringMatchesRegex(matcher *regexp.Regexp) func(string) error {
return func(value string) error {
if !matcher.MatchString(value) {
return fmt.Errorf("value %v must match regex %v", value, matcher)
}
return nil
}
}