unlock

Documentation

Overview

Package unlock provides unlocking helpers.

Index

• func Guard(lock sync.Locker, f func())
• func Guarded[T any](lock sync.Locker, f func() T) T

Examples

• Guard

Functions

func Guard

func Guard(lock sync.Locker, f func())

Guard unlocks the lock, invokes f, and locks the lock again.

Example

package main

import (
	"sync"
	"time"

	"import.name/lock/unlock"
)

func main() {
	var mu sync.Mutex

	mu.Lock()
	defer mu.Unlock()

	unlock.Guard(&mu, func() {
		time.Sleep(time.Microsecond)
	})
}

func Guarded

func Guarded[T any](lock sync.Locker, f func() T) T

Guarded unlocks the lock, invokes f, and locks the lock again. The return value is passed through.