elapsed

Documentation

Overview

Package elapsed provides options for elapsed-time field rendering in clog.

Index

• func Apply(e *Elapsed, opts ...Option)
• type Elapsed
• type Option
  • func WithGradient(stops ...style.ColorStop) Option
  • func WithGradientMax(maximum time.Duration) Option
  • func WithGradientMode(mode style.GradientMode) Option
  • func WithMinimum(minimum time.Duration) Option

Functions

func Apply

func Apply(e *Elapsed, opts ...Option)

Apply applies the given options to e.

Types

type Elapsed

type Elapsed = core.ElapsedField

Elapsed is the value type for elapsed-time fields.

type Option

type Option func(*Elapsed)

Option configures how an elapsed-time field is rendered.

func WithGradient

func WithGradient(stops ...style.ColorStop) Option

WithGradient returns an Option that overrides the logger's elapsed gradient color stops for this field.

clog.Info().Elapsed("elapsed", elapsed.WithGradient(
    style.ColorStop{Position: 0, Color: green},
    style.ColorStop{Position: 1, Color: red},
))

func WithGradientMax

func WithGradientMax(maximum time.Duration) Option

WithGradientMax returns an Option that overrides the logger's elapsed gradient maximum for this field. The gradient runs from the first stop at 0 to the last stop at max.

clog.Info().Elapsed("elapsed", elapsed.WithGradientMax(3*time.Second))

func WithGradientMode

func WithGradientMode(mode style.GradientMode) Option

WithGradientMode returns an Option that overrides the logger's elapsed gradient transition mode (style.GradientFade or style.GradientStep) for this field.

func WithMinimum

func WithMinimum(minimum time.Duration) Option

WithMinimum returns an Option that overrides the logger's elapsed minimum threshold for this field - the field is hidden entirely when its duration falls below minimum.