/
enum.go
69 lines (61 loc) · 1.81 KB
/
enum.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
// Copyright 2019-2023 The Liqo 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 args
import (
"fmt"
"strings"
)
// StringEnum is a type used to validate a string parameter is included in a set of allowed values.
type StringEnum struct {
Allowed []string
Value string
}
// NewEnum give a list of allowed flag parameters, where the second argument is the default.
func NewEnum(allowed []string, d string) *StringEnum {
return &StringEnum{
Allowed: allowed,
Value: d,
}
}
// NewEnumWithVoidDefault give a list of allowed flag parameters, where the default is a void string.
func NewEnumWithVoidDefault(allowed []string) *StringEnum {
return &StringEnum{
Allowed: allowed,
Value: "",
}
}
// String returns the stringified value.
func (a StringEnum) String() string {
return a.Value
}
// Set parses the provided string checking its validity and setting it inside the Value field.
func (a *StringEnum) Set(p string) error {
isIncluded := func(opts []string, val string) bool {
for _, opt := range opts {
if val == opt {
return true
}
}
return false
}
if !isIncluded(a.Allowed, p) {
return fmt.Errorf("%s is not included in %s", p, strings.Join(a.Allowed, ","))
}
a.Value = p
return nil
}
// Type returns the enum type.
func (a *StringEnum) Type() string {
return "string"
}