package syncx

Import Path
	go.pact.im/x/syncx (on go.dev)

Dependency Relation
	imports 2 packages, and imported by one package

Involved Source Files

	   #d doc.go
		Package syncx provides additional synchronization mechanisms and utilities.

	      lock.go
	      map.go
Package-Level Type Names (total 2, both are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Lock (chan)
		Lock is a mutually exclusive lock that supports cancelling acquire operation.

		Methods (total 2, both are exported)
			( Lock) Acquire(ctx context.Context) error
				Acquire locks c. If the lock is already in use, the calling goroutine blocks
				until either the lock is available or the context expires. It returns nil
				if the lock was acquired and a non-nil context error otherwise.

			( Lock) Release()
				Release unlocks c. Unlike sync.Mutex, it is valid to release a Lock without
				a corresponding Acquire. In that case the next Acquire call will unlock the
				Release.

		As Outputs Of (at least one exported)
			func NewLock() Lock

	 type Map[K, V] (struct)

		Type Parameters:
			K: any
			V: any

		Map is a type-safe wrapper for sync.Map.

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			m sync.Map
		Methods (total 6, all are exported)
			(*Map[K, V]) Delete(key K)
				Delete is a type-safe wrapper for sync.Map’s Delete method.

			(*Map[K, V]) Load(key K) (value V, ok bool)
				Load is a type-safe wrapper for sync.Map’s Load method.

			(*Map[K, V]) LoadAndDelete(key K) (value V, loaded bool)
				LoadAndDelete is a type-safe wrapper for sync.Map’s LoadAndDelete method.

			(*Map[K, V]) LoadOrStore(key K, value V) (actual V, loaded bool)
				LoadOrStore is a type-safe wrapper for sync.Map’s LoadOrStore method.

			(*Map[K, V]) Range(f func(key K, value V) bool)
				Range is a type-safe wrapper for sync.Map’s Range method.

			(*Map[K, V]) Store(key K, value V)
				Store is a type-safe wrapper for sync.Map’s Store method.



Package-Level Functions (only one, which is exported)

	 func NewLock() Lock
		NewLock returns a new Lock that allows at most one goroutine to acquire it.

The pages are generated with Golds v0.4.9. (GOOS=linux GOARCH=amd64)