go.uber.org/yarpc@v1.72.1/internal/config/attributemap.go (about)

     1  // Copyright (c) 2022 Uber Technologies, Inc.
     2  //
     3  // Permission is hereby granted, free of charge, to any person obtaining a copy
     4  // of this software and associated documentation files (the "Software"), to deal
     5  // in the Software without restriction, including without limitation the rights
     6  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     7  // copies of the Software, and to permit persons to whom the Software is
     8  // furnished to do so, subject to the following conditions:
     9  //
    10  // The above copyright notice and this permission notice shall be included in
    11  // all copies or substantial portions of the Software.
    12  //
    13  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    14  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    15  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    16  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    17  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    18  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    19  // THE SOFTWARE.
    20  
    21  package config
    22  
    23  import (
    24  	"fmt"
    25  
    26  	"github.com/uber-go/mapdecode"
    27  )
    28  
    29  // AttributeMap is a convenience type on top of a map
    30  // that gives us a cleaner interface to validate config values.
    31  type AttributeMap map[string]interface{}
    32  
    33  // PopString will pop a value from the attribute map and return the string
    34  // it points to, or an error if it couldn't pop the value and decode.
    35  func (m AttributeMap) PopString(name string) (string, error) {
    36  	var s string
    37  	_, err := m.Pop(name, &s)
    38  	return s, err
    39  }
    40  
    41  // PopBool will pop a value from the attribute map and return the bool
    42  // it points to, or an error if it couldn't pop the value and decode.
    43  func (m AttributeMap) PopBool(name string) (bool, error) {
    44  	var b bool
    45  	_, err := m.Pop(name, &b)
    46  	return b, err
    47  }
    48  
    49  // Pop removes the named key from the AttributeMap and decodes the value into
    50  // the dst interface.
    51  func (m AttributeMap) Pop(name string, dst interface{}, opts ...mapdecode.Option) (bool, error) {
    52  	ok, err := m.Get(name, dst, opts...)
    53  	if ok {
    54  		delete(m, name)
    55  	}
    56  	return ok, err
    57  }
    58  
    59  // Get grabs a value from the attribute map and decodes it into the dst
    60  // interface.
    61  func (m AttributeMap) Get(name string, dst interface{}, opts ...mapdecode.Option) (bool, error) {
    62  	v, ok := m[name]
    63  	if !ok {
    64  		return ok, nil
    65  	}
    66  
    67  	err := DecodeInto(dst, v, opts...)
    68  	if err != nil {
    69  		err = fmt.Errorf("failed to read attribute %q: %v. got error: %s", name, v, err)
    70  	}
    71  	return true, err
    72  }
    73  
    74  // Keys returns all the keys of the attribute map.
    75  func (m AttributeMap) Keys() []string {
    76  	keys := make([]string, 0, len(m))
    77  	for key := range m {
    78  		keys = append(keys, key)
    79  	}
    80  	return keys
    81  }
    82  
    83  // Decode attempts to decode the AttributeMap into the dst interface.
    84  func (m AttributeMap) Decode(dst interface{}, opts ...mapdecode.Option) error {
    85  	return DecodeInto(dst, m, opts...)
    86  }