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 // ObjectMarshaler allows user-defined types to efficiently add themselves to the 24 // logging context, and to selectively omit information which shouldn't be 25 // included in logs (e.g., passwords). 26 // 27 // Note: ObjectMarshaler is only used when zap.Object is used or when 28 // passed directly to zap.Any. It is not used when reflection-based 29 // encoding is used. 30 type ObjectMarshaler interface { 31 MarshalLogObject(ObjectEncoder) error 32 } 33 34 // ObjectMarshalerFunc is a type adapter that turns a function into an 35 // ObjectMarshaler. 36 type ObjectMarshalerFunc func(ObjectEncoder) error 37 38 // MarshalLogObject calls the underlying function. 39 func (f ObjectMarshalerFunc) MarshalLogObject(enc ObjectEncoder) error { 40 return f(enc) 41 } 42 43 // ArrayMarshaler allows user-defined types to efficiently add themselves to the 44 // logging context, and to selectively omit information which shouldn't be 45 // included in logs (e.g., passwords). 46 // 47 // Note: ArrayMarshaler is only used when zap.Array is used or when 48 // passed directly to zap.Any. It is not used when reflection-based 49 // encoding is used. 50 type ArrayMarshaler interface { 51 MarshalLogArray(ArrayEncoder) error 52 } 53 54 // ArrayMarshalerFunc is a type adapter that turns a function into an 55 // ArrayMarshaler. 56 type ArrayMarshalerFunc func(ArrayEncoder) error 57 58 // MarshalLogArray calls the underlying function. 59 func (f ArrayMarshalerFunc) MarshalLogArray(enc ArrayEncoder) error { 60 return f(enc) 61 } 62