| 1 |
// Copyright (c) 2016-2023 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 zapfield provides experimental zap.Field helpers whose APIs may be unstable. |
| 22 |
package zapfield |
| 23 |
|
| 24 |
import ( |
| 25 |
"go.uber.org/zap" |
| 26 |
"go.uber.org/zap/zapcore" |
| 27 |
) |
| 28 |
|
| 29 |
// Str constructs a field with the given string-like key and value. |
| 30 |
func Str[K ~string, V ~string](k K, v V) zap.Field { |
| 31 |
return zap.String(string(k), string(v)) |
| 32 |
} |
| 33 |
|
| 34 |
type stringArray[T ~string] []T |
| 35 |
|
| 36 |
func (a stringArray[T]) MarshalLogArray(enc zapcore.ArrayEncoder) error { |
| 37 |
for i := range a { |
| 38 |
enc.AppendString(string(a[i])) |
| 39 |
} |
| 40 |
return nil |
| 41 |
} |
| 42 |
|
| 43 |
// Strs constructs a field that carries a slice of string-like values. |
| 44 |
func Strs[K ~string, V ~[]S, S ~string](k K, v V) zap.Field { |
| 45 |
return zap.Array(string(k), stringArray[S](v)) |
| 46 |
} |