cache

Documentation

Index

• type Singleton
  • func NewSingleton[V any](get func(context.Context) (V, error)) *Singleton[V]
  • func (s *Singleton[V]) Get(ctx context.Context) (V, error)

Types

type Singleton

type Singleton[V any] struct {
	// contains filtered or unexported fields
}

Singleton is a singleton.

It must be constructed with NewSingleton.

func NewSingleton

func NewSingleton[V any](get func(context.Context) (V, error)) *Singleton[V]

NewSingleton returns a new Singleton.

The get function must only return the zero value of V on error.

func (*Singleton[V]) Get

func (s *Singleton[V]) Get(ctx context.Context) (V, error)

Get gets the value, or returns the error in loading the value.

The given context will be used to load the value if not already loaded.

If Singletons call Singletons, lock ordering must be respected.