duration

Documentation

Overview

Package duration provides options for time.Duration field rendering in clog.

Index

• func Apply(d *Duration, opts ...Option)
• type Duration
• 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(d *Duration, opts ...Option)

Apply applies the given options to d.

Types

type Duration

type Duration = core.DurationField

Duration is the value type for duration fields.

type Option

type Option func(*Duration)

Option configures how a duration field is rendered.

func WithGradient

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

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

func WithGradientMax

func WithGradientMax(maximum time.Duration) Option

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

clog.Info().Duration("latency", d, duration.WithGradientMax(3*time.Second))

func WithGradientMode

func WithGradientMode(mode style.GradientMode) Option

WithGradientMode returns an Option that overrides the logger's duration 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 duration minimum threshold for this field - the field is hidden entirely when its value falls below minimum.