summaryrefslogtreecommitdiff
path: root/typedsync/doc.go
blob: e20d44cda4a251b50b4bf75d6f52d48eefa4894b (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
// Copyright (C) 2023  Luke Shumaker <lukeshu@lukeshu.com>
//
// SPDX-License-Identifier: GPL-2.0-or-later

// Package typedsync is an alternative to the standard library's sync
// that uses type-parameters for type safety.
//
// This package does not bother to duplicate documentation from the
// standard library's sync package; see [sync's documentation] for
// full documentation.
//
// Besides requiring type parameters and such, typedsync is a drop-in
// replacement for sync.
//
// [sync's documentation]: https://pkg.go.dev/sync
package typedsync

import (
	"sync"
)

type (
	Locker    = sync.Locker
	Mutex     = sync.Mutex
	Once      = sync.Once
	RWMutex   = sync.RWMutex
	WaitGroup = sync.WaitGroup
)