locker

Documentation

Index

• Variables
• type Locked
  • func New[T any](initial T) *Locked[T]
  • func (s *Locked[T]) Copy(ctx context.Context) (T, error)
  • func (s *Locked[T]) Use(ctx context.Context, fn func(context.Context, T) error) error

Variables

var ErrNested = errors.New("nested locker call")

Types

type Locked

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

func New

func New[T any](initial T) *Locked[T]

New creates a new locker for the given value.

func (*Locked[T]) Copy

func (s *Locked[T]) Copy(ctx context.Context) (T, error)

Copy will return a shallow copy of the locked object.

func (*Locked[T]) Use

func (s *Locked[T]) Use(ctx context.Context, fn func(context.Context, T) error) error

Use will call the function with the locked value