mutex

Documentation

Index

• type Mutex
  • func New[T any](v T) *Mutex[T]
  • func (l *Mutex[T]) Lock() T
  • func (l *Mutex[T]) Unlock()

Types

type Mutex

type Mutex[T any] struct {
	// contains filtered or unexported fields
}

Mutex is a simple mutex that can be used to protect a value.

The zero value is safe to use if the zero value of T is safe to use.

Example:

var m mutex.Mutex[*string]
s := m.Lock()
defer m.Unlock()
*s = "hello"

func New

func New[T any](v T) *Mutex[T]

func (*Mutex[T]) Lock

func (l *Mutex[T]) Lock() T

Lock the Mutex and return its protected value.

func (*Mutex[T]) Unlock

func (l *Mutex[T]) Unlock()

Unlock the Mutex. The value returned by Lock is no longer valid.