github.com/fighterlyt/hugo@v0.47.1/common/types/types.go (about)

     1  // Copyright 2017-present The Hugo Authors. All rights reserved.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  // http://www.apache.org/licenses/LICENSE-2.0
     7  //
     8  // Unless required by applicable law or agreed to in writing, software
     9  // distributed under the License is distributed on an "AS IS" BASIS,
    10  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    11  // See the License for the specific language governing permissions and
    12  // limitations under the License.
    13  
    14  // Package types contains types shared between packages in Hugo.
    15  package types
    16  
    17  import (
    18  	"fmt"
    19  
    20  	"github.com/spf13/cast"
    21  )
    22  
    23  // KeyValueStr is a string tuple.
    24  type KeyValueStr struct {
    25  	Key   string
    26  	Value string
    27  }
    28  
    29  // KeyValues holds an key and a slice of values.
    30  type KeyValues struct {
    31  	Key    interface{}
    32  	Values []interface{}
    33  }
    34  
    35  // KeyString returns the key as a string, an empty string if conversion fails.
    36  func (k KeyValues) KeyString() string {
    37  	return cast.ToString(k.Key)
    38  }
    39  
    40  func (k KeyValues) String() string {
    41  	return fmt.Sprintf("%v: %v", k.Key, k.Values)
    42  }
    43  
    44  func NewKeyValuesStrings(key string, values ...string) KeyValues {
    45  	iv := make([]interface{}, len(values))
    46  	for i := 0; i < len(values); i++ {
    47  		iv[i] = values[i]
    48  	}
    49  	return KeyValues{Key: key, Values: iv}
    50  }