forked from grafana/k6
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathhint.go
64 lines (55 loc) · 1.76 KB
/
hint.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
/*
*
* k6 - a next-generation load testing tool
* Copyright (C) 2021 Load Impact
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
package errext
import "errors"
// HasHint is a wrapper around an error with an attached user hint. These hints
// can be used to give extra human-readable information about the error,
// including suggestions on how the error can be fixed.
type HasHint interface {
error
Hint() string
}
// WithHint is a helper that can attach a hint to the given error. If there is
// no error (i.e. the given error is nil), it won't do anything. If the given
// error already had a hint, this helper will wrap it so that the new hint is
// "new hint (old hint)".
func WithHint(err error, hint string) error {
if err == nil {
return nil // No error, do nothing
}
return withHint{err, hint}
}
type withHint struct {
error
hint string
}
func (wh withHint) Unwrap() error {
return wh.error
}
func (wh withHint) Hint() string {
hint := wh.hint
var oldhint HasHint
if errors.As(wh.error, &oldhint) {
// The given error already had a hint, wrap it
hint = hint + " (" + oldhint.Hint() + ")"
}
return hint
}
var _ HasHint = withHint{}