summaryrefslogtreecommitdiffstats
path: root/common/types/types.go
diff options
context:
space:
mode:
Diffstat (limited to 'common/types/types.go')
-rw-r--r--common/types/types.go52
1 files changed, 52 insertions, 0 deletions
diff --git a/common/types/types.go b/common/types/types.go
new file mode 100644
index 000000000..ca74391f8
--- /dev/null
+++ b/common/types/types.go
@@ -0,0 +1,52 @@
+// Copyright 2018 The Hugo Authors. 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 types contains types shared between packages in Hugo.
+package types
+
+import (
+ "fmt"
+
+ "github.com/spf13/cast"
+)
+
+// KeyValueStr is a string tuple.
+type KeyValueStr struct {
+ Key string
+ Value string
+}
+
+// KeyValues holds an key and a slice of values.
+type KeyValues struct {
+ Key interface{}
+ Values []interface{}
+}
+
+// KeyString returns the key as a string, an empty string if conversion fails.
+func (k KeyValues) KeyString() string {
+ return cast.ToString(k.Key)
+}
+
+func (k KeyValues) String() string {
+ return fmt.Sprintf("%v: %v", k.Key, k.Values)
+}
+
+// NewKeyValuesStrings takes a given key and slice of values and returns a new
+// KeyValues struct.
+func NewKeyValuesStrings(key string, values ...string) KeyValues {
+ iv := make([]interface{}, len(values))
+ for i := 0; i < len(values); i++ {
+ iv[i] = values[i]
+ }
+ return KeyValues{Key: key, Values: iv}
+}