safe

Documentation

Index

• func Lock(fn func(), m ...Mutex)
• func LockRet[T any](fn func() T, m ...Mutex) T
• func LockRetErr[T any](fn func() (T, error), m ...Mutex) (T, error)
• func RLock(fn func(), m ...RWMutex)
• func RLockRet[T any](fn func() T, m ...RWMutex) T
• func RLockRetErr[T any](fn func() (T, error), m ...RWMutex) (T, error)
• type Mutex
  • func NewMutex() Mutex
• type RWMutex
  • func NewRWMutex() RWMutex

Functions

func Lock

func Lock(fn func(), m ...Mutex)

Lock locks one or more mutexes for writing and calls the given function. The mutexes are locked in a deterministic order to avoid deadlocks.

func LockRet

func LockRet[T any](fn func() T, m ...Mutex) T

LockRet locks one or more mutexes for writing and calls the given function, returning a value.

func LockRetErr

func LockRetErr[T any](fn func() (T, error), m ...Mutex) (T, error)

LockRetErr locks one or more mutexes for writing and calls the given function, returning a value and an error.

func RLock

func RLock(fn func(), m ...RWMutex)

RLock locks one or more mutexes for reading and calls the given function. The mutexes are locked in a deterministic order to avoid deadlocks.

func RLockRet

func RLockRet[T any](fn func() T, m ...RWMutex) T

RLockRet locks one or more mutexes for reading and calls the given function, returning a value.

func RLockRetErr

func RLockRetErr[T any](fn func() (T, error), m ...RWMutex) (T, error)

RLockRetErr locks one or more mutexes for reading and calls the given function, returning a value and an error.

Types

type Mutex

type Mutex interface {
	Lock()
	Unlock()
	// contains filtered or unexported methods
}

Mutex is a mutex that can be locked and unlocked.

func NewMutex

func NewMutex() Mutex

NewMutex returns a new mutex.

type RWMutex

type RWMutex interface {
	Mutex

	RLock()
	RUnlock()
}

RWMutex is a mutex that can be locked and unlocked for reading and writing.

func NewRWMutex

func NewRWMutex() RWMutex

NewRWMutex returns a new read-write mutex.