github.com/facebookincubator/go-belt@v0.0.0-20230703220935-39cd348f1a38/pkg/field/map.go (about)

     1  // Copyright 2022 Meta Platforms, Inc. and affiliates.
     2  //
     3  // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
     4  //
     5  // 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
     6  //
     7  // 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
     8  //
     9  // 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
    10  //
    11  // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    12  
    13  package field
    14  
    15  import (
    16  	"fmt"
    17  )
    18  
    19  // Map is just a handy low performance way to pass fields
    20  // similar to how it is done in logrus.
    21  type Map[V any] map[Key]V
    22  
    23  var _ AbstractFields = (Map[Value])(nil)
    24  
    25  // Len implements AbstractFields.
    26  func (m Map[V]) Len() int {
    27  	return len(m)
    28  }
    29  
    30  // ForEachField implements AbstractFields.
    31  func (m Map[V]) ForEachField(callback func(f *Field) bool) bool {
    32  	var f Field
    33  	for k, v := range m {
    34  		f.Key = k
    35  		f.Value = v
    36  		if !callback(&f) {
    37  			return false
    38  		}
    39  	}
    40  	return true
    41  }
    42  
    43  // Map is an abstract map which implements field.AbstractFields.
    44  //
    45  // It differs from Map, because it also accepts non-string keys.
    46  type MapGeneric[K comparable, V any] map[K]V
    47  
    48  var _ AbstractFields = (MapGeneric[string, any])(nil)
    49  
    50  // ForEachField implements field.AbstractFields.
    51  func (m MapGeneric[K, V]) ForEachField(callback func(f *Field) bool) bool {
    52  	var f Field
    53  	for k, v := range m {
    54  		f.Key = fmt.Sprint(k)
    55  		f.Value = v
    56  		if !callback(&f) {
    57  			return false
    58  		}
    59  	}
    60  	return true
    61  }
    62  
    63  // Len implements field.AbstractFields.
    64  func (m MapGeneric[K, V]) Len() int {
    65  	return len(m)
    66  }