godebug

README

Package godebug is Go 1.21.3's internal/godebug package, except that all settings always return "".

Documentation

Index

• type Setting
  • func New(name string) *Setting
  • func (s *Setting) IncNonDefault()
  • func (s *Setting) Name() string
  • func (s *Setting) String() string
  • func (s *Setting) Value() string

Types

type Setting

type Setting struct {
	// contains filtered or unexported fields
}

A Setting is a single setting in the $GODEBUG environment variable.

func New

func New(name string) *Setting

New returns a new Setting for the $GODEBUG setting with the given name.

func (*Setting) IncNonDefault

func (s *Setting) IncNonDefault()

IncNonDefault increments the non-default behavior counter associated with the given setting. This counter is exposed in the runtime/metrics value /godebug/non-default-behavior/<name>:events.

Note that Value must be called at least once before IncNonDefault.

func (*Setting) Name

func (s *Setting) Name() string

Name returns the name of the setting.

func (*Setting) String

func (s *Setting) String() string

String returns a printable form for the setting: name=value.

func (*Setting) Value

func (s *Setting) Value() string

Value returns the current value for the GODEBUG setting s.

Value maintains an internal cache that is synchronized with changes to the $GODEBUG environment variable, making Value efficient to call as frequently as needed. Clients should therefore typically not attempt their own caching of Value's result.