summaryrefslogtreecommitdiff
path: root/vendor/codeberg.org/gruf/go-atomics/string.go
blob: a0a6e115f2392db31e70d668e3a10072e37c2fda (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
48
49
50
51
52
53
54
55
56
57
package atomics

import (
	"sync/atomic"
	"unsafe"
)

// String provides user-friendly means of performing atomic operations on string types.
type String struct{ ptr unsafe.Pointer }

// NewString will return a new String instance initialized with zero value.
func NewString() *String {
	var v string
	return &String{
		ptr: unsafe.Pointer(&v),
	}
}

// Store will atomically store string value in address contained within v.
func (v *String) Store(val string) {
	atomic.StorePointer(&v.ptr, unsafe.Pointer(&val))
}

// Load will atomically load string value at address contained within v.
func (v *String) Load() string {
	return *(*string)(atomic.LoadPointer(&v.ptr))
}

// CAS performs a compare-and-swap for a(n) string value at address contained within v.
func (v *String) CAS(cmp, swp string) bool {
	for {
		// Load current value at address
		ptr := atomic.LoadPointer(&v.ptr)
		cur := *(*string)(ptr)

		// Perform comparison against current
		if !(cur == cmp) {
			return false
		}

		// Attempt to replace pointer
		if atomic.CompareAndSwapPointer(
			&v.ptr,
			ptr,
			unsafe.Pointer(&swp),
		) {
			return true
		}
	}
}

// Swap atomically stores new string value into address contained within v, and returns previous value.
func (v *String) Swap(swp string) string {
	ptr := unsafe.Pointer(&swp)
	ptr = atomic.SwapPointer(&v.ptr, ptr)
	return *(*string)(ptr)
}