syncx

Documentation

Overview

Package syncx provides some useful synchronization primitives.

Index

• type AtomicValue
  • func Value[T any](v *T) *AtomicValue[T]
  • func (v *AtomicValue[T]) Set(fn func(value *T))
• type Pool
  • func NewPool[T any](newFn func() T) *Pool[T]
  • func (p *Pool[T]) Get() T
  • func (p *Pool[T]) Put(value T)

Types

type AtomicValue

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

AtomicValue is a strongly typed version of sync/atomic.Value

func Value

func Value[T any](v *T) *AtomicValue[T]

Value returns a new Value

func (*AtomicValue[T]) Set

func (v *AtomicValue[T]) Set(fn func(value *T))

Set sets the value

type Pool

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

Pool is a strongly typed version of sync.Pool from go standard library

func NewPool

func NewPool[T any](newFn func() T) *Pool[T]

func (*Pool[T]) Get

func (p *Pool[T]) Get() T

Get returns an arbitrary item from the pool.

func (*Pool[T]) Put

func (p *Pool[T]) Put(value T)

Put places an item in the pool