formatter

type Aware interface {
	// GetFormatter returns the current formatter.
	GetFormatter() Formatter
}

type Formatter interface {
	// Format formats the given event to a format which can logged to a console,
	// file, ...
	Format(log.Event, log.Provider, hints.Hints) ([]byte, error)
}

type Func func(log.Event, log.Provider, hints.Hints) ([]byte, error)

type Json struct {
	// KeyLevel is the key to write the level of log entries to the output with.
	// If not set DefaultKeyLevel is used.
	KeyLevel string

	// LevelFormatter is used to format the level.Level of a given log.Entry.
	// into the field with key of KeyLevel.
	LevelFormatter Level

	// PrintRootLogger will (if set to true) also print the field logger for the
	// root logger. If set to false the logger field will be only printed for
	// every logger but not for the root one. If not set set
	// DefaultPrintRootLogger will be used.
	PrintRootLogger *bool

	// KeySorter will force the printed fields to be sorted using this sorter.
	// The fields which contains the level.Level will be always the first,
	// regardless of the result of the KeySorter. If this field is empty the
	// fields are not sorted and the order is not deterministic and reliable.
	KeySorter fields.KeySorter
}

type Level interface {
	// FormatLevel formats the given level.Level.
	FormatLevel(in level.Level, using log.Provider) (interface{}, error)
}

type LevelFunc func(in level.Level, using log.Provider) (interface{}, error)

type MutableAware interface {
	Aware

	// SetFormatter modifies the current formatter to the given one.
	SetFormatter(Formatter)
}

type QuoteType uint8

type SimpleTextValue struct {
	// QuoteType defines how values are quoted.
	QuoteType QuoteType
}

type Template struct {
	// ColorMode defines when the output should be colorized. If not configured
	// color.ModeAuto will be used by default.
	ColorMode color.Mode

	// LevelColorizer is used to colorize output based on the level.Level of an
	// log.Event to be logged. If not set nlevel.DefaultColorizer will be used.
	LevelColorizer nlevel.Colorizer
	// contains filtered or unexported fields
}

type TemplateFactory func(rootFuncMap template.FuncMap) (*template.Template, error)

type TemplateRenderingContext struct {
	// log.Event is the foundation of this context.
	log.Event

	// Provider contains the corresponding log.Provider of the current log.Event.
	Provider log.Provider

	// Template is the actual instance of Template which which is executing the
	// rendering of the log.Event.
	Template *Template
	// contains filtered or unexported fields
}

type Text struct {
	// ColorMode defines when the output should be colorized. If not configured
	// color.ModeAuto will be used by default.
	ColorMode color.Mode

	// LevelColorizer is used to colorize output based on the level.Level of an
	// log.Event to be logged. If not set nlevel.DefaultColorizer will be used.
	LevelColorizer nlevel.Colorizer

	// TimeLayout defines how the time of log events should be formatted. Please
	// see time.Time#Format() for more details. If not set DefaultTimeLayout
	// will be used.
	TimeLayout string

	// LevelWidth defines the width of the string representation of the level
	// which will be printed to the output. If set to 0 the length will be kept
	// as it is. If bigger than 0 and has the exact same length of the printed
	// text; it will be printed as it is. If the representation is longer it
	// will be trimmed; if shorter whitespaces will be added. If smaller than 0
	// it behaves the same way but whitespaces will be added at the beginning
	// instead of the end. If not set DefaultLevelWidth will be used.
	LevelWidth *int8

	// MinMessageWidth defines the width of the message which will be printed to
	// the output. If set to 0 the length will be kept as it is. If bigger than
	// 0 and has the exact same length of the printed text or the printed text
	// will be longer ; it will be printed as it is. If the message is shorter
	// whitespaces will be added to the end. If smaller than 0 it behaves the
	// same way but whitespaces will be added at the beginning instead of the
	// end. If not set DefaultMinMessageWidth will be used.
	MinMessageWidth *int16

	// MultiLineMessageAfterFields will force multiline messages
	// (if set to true) to be printed behind the fields; instead (if default)
	// in front of them. If not set DefaultMultiLineMessageAfterFields will
	// be used.
	MultiLineMessageAfterFields *bool

	// AllowMultiLineMessage will allow (if set to true) multiline messages to
	// be printed as multiline to the output, too. If set to false linebreaks
	// will be replaced with ⏎. If not set DefaultAllowMultiLineMessage will
	// be used.
	AllowMultiLineMessage *bool

	// PrintRootLogger will (if set to true) also print the field logger for the
	// root logger. If set to false the logger field will be only printed for
	// every logger but not for the root one. If not set
	// DefaultPrintRootLogger will be used.
	PrintRootLogger *bool

	// ValueFormatter is used to format the field values (not the message). If
	// not set formatter.DefaultTextValue will be used.
	ValueFormatter TextValue

	// KeySorter is used to sort the field when they are printed. If not set
	// fields.DefaultKeySorter will be used.
	KeySorter fields.KeySorter
	// contains filtered or unexported fields
}

type TextValue interface {
	// FormatValue formats the given value to a readable format.
	FormatTextValue(value interface{}, provider log.Provider) ([]byte, error)
}

type TextValueFunc func(interface{}, log.Provider) ([]byte, error)