1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360
|
// Copyright 2022 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
package slog
import (
"fmt"
"math"
"strconv"
"time"
"golang.org/x/exp/slices"
)
// Definitions for Value.
// The Value type itself can be found in value_{safe,unsafe}.go.
// Kind is the kind of a Value.
type Kind int
// Unexported version of Kind, just so we can store Kinds in Values.
// (No user-provided value has this type.)
type kind Kind
// The following list is sorted alphabetically, but it's also important that
// AnyKind is 0 so that a zero Value represents nil.
const (
AnyKind Kind = iota
BoolKind
DurationKind
Float64Kind
Int64Kind
StringKind
TimeKind
Uint64Kind
GroupKind
LogValuerKind
)
var kindStrings = []string{
"Any",
"Bool",
"Duration",
"Float64",
"Int64",
"String",
"Time",
"Uint64",
"GroupKind",
"LogValuer",
}
func (k Kind) String() string {
if k >= 0 && int(k) < len(kindStrings) {
return kindStrings[k]
}
return "<unknown slog.Kind>"
}
//////////////// Constructors
// IntValue returns a Value for an int.
func IntValue(v int) Value {
return Int64Value(int64(v))
}
// Int64Value returns a Value for an int64.
func Int64Value(v int64) Value {
return Value{num: uint64(v), any: Int64Kind}
}
// Uint64Value returns a Value for a uint64.
func Uint64Value(v uint64) Value {
return Value{num: v, any: Uint64Kind}
}
// Float64Value returns a Value for a floating-point number.
func Float64Value(v float64) Value {
return Value{num: math.Float64bits(v), any: Float64Kind}
}
// BoolValue returns a Value for a bool.
func BoolValue(v bool) Value {
u := uint64(0)
if v {
u = 1
}
return Value{num: u, any: BoolKind}
}
// Unexported version of *time.Location, just so we can store *time.Locations in
// Values. (No user-provided value has this type.)
type timeLocation *time.Location
// TimeValue returns a Value for a time.Time.
// It discards the monotonic portion.
func TimeValue(v time.Time) Value {
return Value{num: uint64(v.UnixNano()), any: timeLocation(v.Location())}
}
// DurationValue returns a Value for a time.Duration.
func DurationValue(v time.Duration) Value {
return Value{num: uint64(v.Nanoseconds()), any: DurationKind}
}
// GroupValue returns a new Value for a list of Attrs.
// The caller must not subsequently mutate the argument slice.
func GroupValue(as ...Attr) Value {
return groupValue(as)
}
// AnyValue returns a Value for the supplied value.
//
// Given a value of one of Go's predeclared string, bool, or
// (non-complex) numeric types, AnyValue returns a Value of kind
// String, Bool, Uint64, Int64, or Float64. The width of the
// original numeric type is not preserved.
//
// Given a time.Time or time.Duration value, AnyValue returns a Value of kind
// TimeKind or DurationKind. The monotonic time is not preserved.
//
// For nil, or values of all other types, including named types whose
// underlying type is numeric, AnyValue returns a value of kind AnyKind.
func AnyValue(v any) Value {
switch v := v.(type) {
case string:
return StringValue(v)
case int:
return Int64Value(int64(v))
case int64:
return Int64Value(v)
case uint64:
return Uint64Value(v)
case bool:
return BoolValue(v)
case time.Duration:
return DurationValue(v)
case time.Time:
return TimeValue(v)
case uint8:
return Uint64Value(uint64(v))
case uint16:
return Uint64Value(uint64(v))
case uint32:
return Uint64Value(uint64(v))
case uintptr:
return Uint64Value(uint64(v))
case int8:
return Int64Value(int64(v))
case int16:
return Int64Value(int64(v))
case int32:
return Int64Value(int64(v))
case float64:
return Float64Value(v)
case float32:
return Float64Value(float64(v))
case []Attr:
return GroupValue(v...)
case Kind:
return Value{any: kind(v)}
default:
return Value{any: v}
}
}
//////////////// Accessors
// Any returns the Value's value as an any.
func (v Value) Any() any {
switch v.Kind() {
case AnyKind, GroupKind, LogValuerKind:
if k, ok := v.any.(kind); ok {
return Kind(k)
}
return v.any
case Int64Kind:
return int64(v.num)
case Uint64Kind:
return v.num
case Float64Kind:
return v.float()
case StringKind:
return v.str()
case BoolKind:
return v.bool()
case DurationKind:
return v.duration()
case TimeKind:
return v.time()
default:
panic(fmt.Sprintf("bad kind: %s", v.Kind()))
}
}
// Int64 returns the Value's value as an int64. It panics
// if the value is not a signed integer.
func (v Value) Int64() int64 {
if g, w := v.Kind(), Int64Kind; g != w {
panic(fmt.Sprintf("Value kind is %s, not %s", g, w))
}
return int64(v.num)
}
// Uint64 returns the Value's value as a uint64. It panics
// if the value is not an unsigned integer.
func (v Value) Uint64() uint64 {
if g, w := v.Kind(), Uint64Kind; g != w {
panic(fmt.Sprintf("Value kind is %s, not %s", g, w))
}
return v.num
}
// Bool returns the Value's value as a bool. It panics
// if the value is not a bool.
func (v Value) Bool() bool {
if g, w := v.Kind(), BoolKind; g != w {
panic(fmt.Sprintf("Value kind is %s, not %s", g, w))
}
return v.bool()
}
func (a Value) bool() bool {
return a.num == 1
}
// Duration returns the Value's value as a time.Duration. It panics
// if the value is not a time.Duration.
func (a Value) Duration() time.Duration {
if g, w := a.Kind(), DurationKind; g != w {
panic(fmt.Sprintf("Value kind is %s, not %s", g, w))
}
return a.duration()
}
func (a Value) duration() time.Duration {
return time.Duration(int64(a.num))
}
// Float64 returns the Value's value as a float64. It panics
// if the value is not a float64.
func (v Value) Float64() float64 {
if g, w := v.Kind(), Float64Kind; g != w {
panic(fmt.Sprintf("Value kind is %s, not %s", g, w))
}
return v.float()
}
func (a Value) float() float64 {
return math.Float64frombits(a.num)
}
// Time returns the Value's value as a time.Time. It panics
// if the value is not a time.Time.
func (v Value) Time() time.Time {
if g, w := v.Kind(), TimeKind; g != w {
panic(fmt.Sprintf("Value kind is %s, not %s", g, w))
}
return v.time()
}
func (v Value) time() time.Time {
return time.Unix(0, int64(v.num)).In(v.any.(timeLocation))
}
// LogValuer returns the Value's value as a LogValuer. It panics
// if the value is not a LogValuer.
func (v Value) LogValuer() LogValuer {
return v.any.(LogValuer)
}
// Group returns the Value's value as a []Attr.
// It panics if the Value's Kind is not GroupKind.
func (v Value) Group() []Attr {
return v.group()
}
//////////////// Other
// Equal reports whether two Values have equal keys and values.
func (v1 Value) Equal(v2 Value) bool {
k1 := v1.Kind()
k2 := v2.Kind()
if k1 != k2 {
return false
}
switch k1 {
case Int64Kind, Uint64Kind, BoolKind, DurationKind:
return v1.num == v2.num
case StringKind:
return v1.str() == v2.str()
case Float64Kind:
return v1.float() == v2.float()
case TimeKind:
return v1.time().Equal(v2.time())
case AnyKind, LogValuerKind:
return v1.any == v2.any // may panic if non-comparable
case GroupKind:
return slices.EqualFunc(v1.uncheckedGroup(), v2.uncheckedGroup(), Attr.Equal)
default:
panic(fmt.Sprintf("bad kind: %s", k1))
}
}
// append appends a text representation of the Value to dst.
// The value is formatted as with fmt.Sprint.
func (v Value) append(dst []byte) []byte {
switch v.Kind() {
case StringKind:
return append(dst, v.str()...)
case Int64Kind:
return strconv.AppendInt(dst, int64(v.num), 10)
case Uint64Kind:
return strconv.AppendUint(dst, v.num, 10)
case Float64Kind:
return strconv.AppendFloat(dst, v.float(), 'g', -1, 64)
case BoolKind:
return strconv.AppendBool(dst, v.bool())
case DurationKind:
return append(dst, v.duration().String()...)
case TimeKind:
return append(dst, v.time().String()...)
case AnyKind, GroupKind, LogValuerKind:
return append(dst, fmt.Sprint(v.any)...)
default:
panic(fmt.Sprintf("bad kind: %s", v.Kind()))
}
}
// A LogValuer is a Value that transforms itself into a different Value (or,
// using the Group feature, a group of Attrs) at the moment it is logged.
//
// This mechanism may be used to defer expensive operations until they are
// needed, or to expand a single value into a sequence of components.
type LogValuer interface {
LogValue() Value
}
const maxLogValues = 100
// Resolve repeatedly calls LogValue on v while it implements LogValuer,
// and returns the result.
// If the number of LogValue calls exceeds a threshold, a Value containing an
// error is returned.
// Resolve's return value is guaranteed not to be of Kind LogValuerKind.
func (v Value) Resolve() Value {
orig := v
for i := 0; i < maxLogValues; i++ {
if v.Kind() != LogValuerKind {
return v
}
v = v.LogValuer().LogValue()
}
err := fmt.Errorf("LogValue called too many times on Value of type %T", orig.Any())
return AnyValue(err)
}
|