internal

Documentation

Overview

Package internal contains stateful global variables internal to zerrors. This package owes its existence to the separation of zerror's functionality into two packages (zerrors & zmain), which requires for the two to have some internal common package.

Index

• func Basic(err error) string
• func Detail(err error) string
• func GetFrameCapture() bool
• func SetBasic(f func(error) string)
• func SetDetail(f func(error) string)
• func UnsetFrameCapture()

Functions

func Basic

func Basic(err error) string

Basic serialises an error using the basic encoder function. It is used to produce `Error() string` for zerrors.

func Detail

func Detail(err error) string

Detail serialises an error using the detail encoder function. It is used to produce `zerrors.Detail(error) string`.

func GetFrameCapture

func GetFrameCapture() bool

GetFrameCapture is a getter for frameCapture.

func SetBasic

func SetBasic(f func(error) string)

SetBasic modifies how the `Error() string` method serialises zerrors. Note this should not rely on the `Error()` method of zerrors or it may enter an infinite recursion.

func SetDetail

func SetDetail(f func(error) string)

SetDetail modifies how the `zerrors.Detail(error) string` method serialises zerrors. Note this should not rely on the `Detail(error)` function of zerrors or it may enter an infinite recursion.

func UnsetFrameCapture

func UnsetFrameCapture()

UnsetFrameCapture is only used in zmain, and in testing.