encoder.go

package glog

import "time"

// EncoderFunc used to return a new Encoder instances.
type EncoderFunc func() Encoder

// FieldEncoder used to add single elements.
type FieldEncoder interface {
	// AppendByte the value to an integer format.
	AppendByte(b byte)
	AppendString(s string)
	AppendBool(v bool)
	AppendInt64(i int64)
	AppendUnt64(i uint64)
	AppendFloat64(f float64)
	AppendComplex128(c complex128)

	// AppendRawBytes for adds already serialized data.
	AppendRawBytes(bs []byte)
	// AppendRawString for adds already serialized data.
	AppendRawString(s string)

	AppendTime(t time.Time, layout string)
	AppendDuration(d time.Duration, layout int8)

	AppendArray(am ArrayMarshaler) error
	AppendObject(om ObjectMarshaler) error

	// AppendInterface uses reflection to serialize arbitrary objects, so it's
	// slow and allocation-heavy.
	AppendInterface(i interface{}) error
}

// ArrayEncoder used to add array-type field.
type ArrayEncoder interface {
	FieldEncoder
}

// ObjectEncoder used to add an k/v field.
type ObjectEncoder interface {
	// AddByte the value to an integer format.
	AddByte(k string, b byte)
	AddString(k string, s string)
	AddBool(k string, v bool)
	AddInt64(k string, i int64)
	AddUnt64(k string, i uint64)
	AddFloat64(k string, f float64)
	AddComplex128(k string, c complex128)

	// AddRawBytes for adds already serialized data under key.
	AddRawBytes(k string, bs []byte)
	// AddRawString for adds already serialized data under key.
	AddRawString(k string, s string)

	AddTime(k string, t time.Time, layout string)
	AddDuration(k string, d time.Duration, layout int8)

	AddArray(k string, am ArrayMarshaler) error
	AddObject(k string, om ObjectMarshaler) error

	// AddInterface uses reflection to serialize arbitrary objects, so it can be
	// slow and allocation-heavy.
	AddInterface(k string, i interface{}) error
}

// BuildEncoder used to add some specific fields.
type BuildEncoder interface {
	AddMsg(msg string)
	AddEntryTime(t time.Time, layout string)
	AddLevel(level Level)
	AddCaller(skip int)

	// AddBeginMarker add the begin marker.
	AddBeginMarker()
	// AddEndMarker add the end marker.
	AddEndMarker()
	// AddLineBreak add the line break.
	AddLineBreak()

	// WriteIn used to write encoded data.
	WriteIn(p []byte) error
}

type Encoder interface {
	ObjectEncoder
	BuildEncoder

	// Bytes returns a mutable reference to the byte slice of the Encoder
	Bytes() []byte
	// Close callers must not retain references to the Encoder after calling Close.
	Close() error
}