codec

Documentation

Index

• Constants
• func Register(codec string, build CodecFunc)
• func TimeStampIsValid(layout string, skrew time.Duration) bool
• type CodecFunc
• type Encoder
  • func NewCodec(name string, out io.Writer, opts ...Option) Encoder
• type Option
  • func WithNoColor() Option
  • func WithPrittyPrint(indent string) Option
  • func WithTimestamps(layout string) Option
  • func WithoutTimestamps() Option
• type Options
  • func NewOptions(opts ...Option) Options
  • func (conf *Options) Timestamp(date time.Time) *Timestamp
• type Timestamp
  • func (ts *Timestamp) MarshalText() ([]byte, error)
  • func (ts *Timestamp) String() string

Constants

const (
	// Default timestamp format
	TimeStamp = "2006-01-02T15:04:05.999Z07:00" // time.RFC3339Nano
)

Functions

func Register

func Register(codec string, build CodecFunc)

func TimeStampIsValid

func TimeStampIsValid(layout string, skrew time.Duration) bool

Types

type CodecFunc

type CodecFunc func(out io.Writer, opts ...Option) Encoder

type Encoder

type Encoder interface {
	Encode(log.Record) error
}

func NewCodec

func NewCodec(name string, out io.Writer, opts ...Option) Encoder

type Option

type Option func(*Options)

func WithNoColor

func WithNoColor() Option

func WithPrittyPrint

func WithPrittyPrint(indent string) Option

func WithTimestamps

func WithTimestamps(layout string) Option

func WithoutTimestamps

func WithoutTimestamps() Option

type Options

type Options struct {
	// TimeStamp format layout
	// To disable timestamp(s) output: just leave it empty
	// https://pkg.go.dev/time#pkg-constants
	TimeStamp string
	// PrettyPrint indent string
	// To disable - leave it empty
	PrettyPrint string
	// Do NOT colorize output records.
	NoColor bool
}

Options for encoding

func NewOptions

func NewOptions(opts ...Option) Options

func (*Options) Timestamp

func (conf *Options) Timestamp(date time.Time) *Timestamp

type Timestamp

type Timestamp struct {
	Time   time.Time
	Format string
}

Timestamp. NULLable.

func (*Timestamp) MarshalText

func (ts *Timestamp) MarshalText() ([]byte, error)

func (*Timestamp) String

func (ts *Timestamp) String() string