summaryrefslogtreecommitdiff
path: root/vendor/codeberg.org/gruf/go-errors/v2/once.go
blob: 83a45a61f7eeea07d6ab30a64e26014ea6662a72 (plain)
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
package errors

import (
	"sync/atomic"
	"unsafe"
)

// OnceError is an error structure that supports safe multi
// threaded usage and setting only once (until reset).
type OnceError struct{ err unsafe.Pointer }

// NewOnce returns a new OnceError instance.
func NewOnce() OnceError {
	return OnceError{
		err: nil,
	}
}

// Store will safely set the OnceError to value, no-op if nil.
func (e *OnceError) Store(err error) {
	// Nothing to do
	if err == nil {
		return
	}

	// Only set if not already
	atomic.CompareAndSwapPointer(
		&e.err,
		nil,
		unsafe.Pointer(&err),
	)
}

// Load will load the currently stored error.
func (e *OnceError) Load() error {
	return *(*error)(atomic.LoadPointer(&e.err))
}

// IsSet returns whether OnceError has been set.
func (e *OnceError) IsSet() bool {
	return (atomic.LoadPointer(&e.err) != nil)
}

// Reset will reset the OnceError value.
func (e *OnceError) Reset() {
	atomic.StorePointer(&e.err, nil)
}