reflected_encoder.go raw

   1  // Copyright (c) 2016 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 zapcore
  22  
  23  import (
  24  	"encoding/json"
  25  	"io"
  26  )
  27  
  28  // ReflectedEncoder serializes log fields that can't be serialized with Zap's
  29  // JSON encoder. These have the ReflectType field type.
  30  // Use EncoderConfig.NewReflectedEncoder to set this.
  31  type ReflectedEncoder interface {
  32  	// Encode encodes and writes to the underlying data stream.
  33  	Encode(interface{}) error
  34  }
  35  
  36  func defaultReflectedEncoder(w io.Writer) ReflectedEncoder {
  37  	enc := json.NewEncoder(w)
  38  	// For consistency with our custom JSON encoder.
  39  	enc.SetEscapeHTML(false)
  40  	return enc
  41  }
  42