README
¶
cockroachdb/errors: an error library with network portability
After the discussion in https://github.com/cockroachdb/cockroach/pull/36987 and https://github.com/cockroachdb/cockroach/pull/37121
Documentation
¶
Index ¶
- func AssertionFailedWithDepthf(depth int, format string, args ...interface{}) error
- func AssertionFailedf(format string, args ...interface{}) error
- func BuildSentryReport(err error) (string, []raven.Interface, map[string]interface{})
- func Cause(err error) error
- func DecodeError(enc EncodedError) error
- func EnsureNotInDomain(err error, constructor DomainOverrideFn, forbiddenDomains ...Domain) error
- func Errorf(format string, args ...interface{}) error
- func FlattenDetails(err error) string
- func FlattenHints(err error) string
- func GetAllDetails(err error) []string
- func GetAllHints(err error) []string
- func GetOneLineSource(err error) (file string, line int, fn string, ok bool)
- func GetTelemetryKeys(err error) []string
- func Handled(err error) error
- func HandledInDomain(err error, domain Domain) error
- func HandledInDomainWithMessage(err error, domain Domain, msg string) error
- func HandledWithMessage(err error, msg string) error
- func HasAssertionFailure(err error) bool
- func HasIssueLink(err error) bool
- func HasUnimplementedError(err error) bool
- func If(err error, pred func(err error) (interface{}, bool)) (interface{}, bool)
- func Is(err, reference error) bool
- func IsAny(err error, references ...error) bool
- func IsAssertionFailure(err error) bool
- func IsIssueLink(err error) bool
- func IsUnimplementedError(err error) bool
- func Mark(err error, reference error) error
- func New(msg string) error
- func NewAssertionErrorWithWrappedErrf(origErr error, format string, args ...interface{}) error
- func NewWithDepth(depth int, msg string) error
- func NewWithDepthf(depth int, format string, args ...interface{}) error
- func Newf(format string, args ...interface{}) error
- func NotInDomain(err error, doms ...Domain) bool
- func Redact(r interface{}) string
- func RegisterLeafDecoder(typeName TypeKey, decoder LeafDecoder)
- func RegisterLeafEncoder(typeName TypeKey, encoder LeafEncoder)
- func RegisterWrapperDecoder(typeName TypeKey, decoder WrapperDecoder)
- func RegisterWrapperEncoder(typeName TypeKey, encoder WrapperEncoder)
- func ReportError(err error) (string, error)
- func UnimplementedError(issueLink IssueLink, msg string) error
- func UnimplementedErrorf(issueLink IssueLink, format string, args ...interface{}) error
- func UnwrapAll(err error) error
- func UnwrapOnce(err error) error
- func WithAssertionFailure(err error) error
- func WithDetail(err error, msg string) error
- func WithDetailf(err error, format string, args ...interface{}) error
- func WithDomain(err error, domain Domain) error
- func WithHint(err error, msg string) error
- func WithHintf(err error, format string, args ...interface{}) error
- func WithIssueLink(err error, issue IssueLink) error
- func WithMessage(err error, msg string) error
- func WithMessagef(err error, format string, args ...interface{}) error
- func WithSafeDetails(err error, format string, args ...interface{}) error
- func WithSecondaryError(err error, additionalErr error) error
- func WithStack(err error) error
- func WithStackDepth(err error, depth int) error
- func WithTelemetry(err error, keys ...string) error
- func Wrap(err error, msg string) error
- func WrapWithDepth(depth int, err error, msg string) error
- func WrapWithDepthf(depth int, err error, format string, args ...interface{}) error
- func Wrapf(err error, format string, args ...interface{}) error
- type Domain
- type DomainOverrideFn
- type EncodedError
- type IssueLink
- type LeafDecoder
- type LeafEncoder
- type ReportableStackTrace
- type SafeDetailPayload
- type SafeDetailer
- type SafeMessager
- type TypeKey
- type WrapperDecoder
- type WrapperEncoder
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AssertionFailedWithDepthf ¶
AssertionFailedWithDepthf forwards a definition.
func AssertionFailedf ¶
AssertionFailedf forwards a definition.
func BuildSentryReport ¶
BuildSentryReport forwards a definition.
func EnsureNotInDomain ¶
func EnsureNotInDomain(err error, constructor DomainOverrideFn, forbiddenDomains ...Domain) error
EnsureNotInDomain forwards a definition.
func GetOneLineSource ¶
GetOneLineSource forwards a definition.
func GetTelemetryKeys ¶
GetTelemetryKeys forwards a definition.
func HandledInDomain ¶
HandledInDomain forwards a definition.
func HandledInDomainWithMessage ¶
HandledInDomainWithMessage forwards a definition.
func HandledWithMessage ¶
HandledWithMessage forwards a definition.
func HasAssertionFailure ¶
HasAssertionFailure forwards a definition.
func HasUnimplementedError ¶
HasUnimplementedError forwards a definition.
func IsAssertionFailure ¶
IsAssertionFailure forwards a definition.
func IsUnimplementedError ¶
IsUnimplementedError forwards a definition.
func NewAssertionErrorWithWrappedErrf ¶
NewAssertionErrorWithWrappedErrf forwards a definition.
func NewWithDepth ¶
NewWithDepth forwards a definition.
func NewWithDepthf ¶
NewWithDepthf forwards a definition.
func NotInDomain ¶
NotInDomain forwards a definition.
func Redact ¶
func Redact(r interface{}) string
Redact returns a redacted version of the supplied item that is safe to use in anonymized reporting.
func RegisterLeafDecoder ¶
func RegisterLeafDecoder(typeName TypeKey, decoder LeafDecoder)
RegisterLeafDecoder forwards a definition.
func RegisterLeafEncoder ¶
func RegisterLeafEncoder(typeName TypeKey, encoder LeafEncoder)
RegisterLeafEncoder forwards a definition.
func RegisterWrapperDecoder ¶
func RegisterWrapperDecoder(typeName TypeKey, decoder WrapperDecoder)
RegisterWrapperDecoder forwards a definition.
func RegisterWrapperEncoder ¶
func RegisterWrapperEncoder(typeName TypeKey, encoder WrapperEncoder)
RegisterWrapperEncoder forwards a definition.
func UnimplementedError ¶
UnimplementedError forwards a definition.
func UnimplementedErrorf ¶
UnimplementedErrorf forwards a definition.
func WithAssertionFailure ¶
WithAssertionFailure forwards a definition.
func WithDetailf ¶
WithDetailf forwards a definition.
func WithIssueLink ¶
WithIssueLink forwards a definition.
func WithMessagef ¶
WithMessagef forwards a definition.
func WithSafeDetails ¶
WithSafeDetails forwards a definition.
func WithSecondaryError ¶
WithSecondaryError forwards a definition.
func WithStackDepth ¶
WithStackDepth forwards a definition.
func WithTelemetry ¶
WithTelemetry forwards a definition.
func WrapWithDepth ¶
WrapWithDepth forwards a definition.
func WrapWithDepthf ¶
WrapWithDepthf forwards a definition.
Types ¶
type Domain ¶
Domain forwards a definition.
func PackageDomainAtDepth ¶
PackageDomainAtDepth forwards a definition.
type DomainOverrideFn ¶
DomainOverrideFn forwards a definition.
type IssueLink ¶
IssueLink forwards a definition.
func GetAllIssueLinks ¶
GetAllIssueLinks forwards a definition.
type ReportableStackTrace ¶
type ReportableStackTrace = withstack.ReportableStackTrace
ReportableStackTrace forwards a definition.
func GetReportableStackTrace ¶
func GetReportableStackTrace(err error) *ReportableStackTrace
GetReportableStackTrace forwards a definition.
type SafeDetailPayload ¶
type SafeDetailPayload = errbase.SafeDetailPayload
SafeDetailPayload forwards a definition.
func GetAllSafeDetails ¶
func GetAllSafeDetails(err error) []SafeDetailPayload
GetAllSafeDetails forwards a definition.
func GetSafeDetails ¶
func GetSafeDetails(err error) (payload SafeDetailPayload)
GetSafeDetails forwards a definition.
type SafeMessager ¶
type SafeMessager = safedetails.SafeMessager
SafeMessager forwards a definition.
type WrapperDecoder ¶
type WrapperDecoder = errbase.WrapperDecoder
WrapperDecoder forwards a definition.
type WrapperEncoder ¶
type WrapperEncoder = errbase.WrapperEncoder
WrapperEncoder forwards a definition.
Source Files
¶
Directories
¶
| Path | Synopsis |
|---|---|
|
Package errutil combines primitives from the library, the Go errors package and github.com/pkg/errors.
|
Package errutil combines primitives from the library, the Go errors package and github.com/pkg/errors. |