slice

Documentation

Index

• type UserSliceLoader
  • func NewLoader() *UserSliceLoader
  • func NewUserSliceLoader(config UserSliceLoaderConfig) *UserSliceLoader
  • func (l *UserSliceLoader) Clear(key int)
  • func (l *UserSliceLoader) Load(key int) ([]example.User, error)
  • func (l *UserSliceLoader) LoadAll(keys []int) ([][]example.User, []error)
  • func (l *UserSliceLoader) LoadAllThunk(keys []int) func() ([][]example.User, []error)
  • func (l *UserSliceLoader) LoadThunk(key int) func() ([]example.User, error)
  • func (l *UserSliceLoader) Prime(key int, value []example.User) bool
• type UserSliceLoaderConfig

Types

type UserSliceLoader

type UserSliceLoader struct {
	// contains filtered or unexported fields
}

UserSliceLoader batches and caches requests

func NewLoader

func NewLoader() *UserSliceLoader

func NewUserSliceLoader

func NewUserSliceLoader(config UserSliceLoaderConfig) *UserSliceLoader

NewUserSliceLoader creates a new UserSliceLoader given a fetch, wait, and maxBatch

func (*UserSliceLoader) Clear

func (l *UserSliceLoader) Clear(key int)

Clear the value at key from the cache, if it exists

func (*UserSliceLoader) Load

func (l *UserSliceLoader) Load(key int) ([]example.User, error)

Load a user by key, batching and caching will be applied automatically

func (*UserSliceLoader) LoadAll

func (l *UserSliceLoader) LoadAll(keys []int) ([][]example.User, []error)

LoadAll fetches many keys at once. It will be broken into appropriate sized sub batches depending on how the loader is configured

func (*UserSliceLoader) LoadAllThunk

func (l *UserSliceLoader) LoadAllThunk(keys []int) func() ([][]example.User, []error)

LoadAllThunk returns a function that when called will block waiting for a users. This method should be used if you want one goroutine to make requests to many different data loaders without blocking until the thunk is called.

func (*UserSliceLoader) LoadThunk

func (l *UserSliceLoader) LoadThunk(key int) func() ([]example.User, error)

LoadThunk returns a function that when called will block waiting for a user. This method should be used if you want one goroutine to make requests to many different data loaders without blocking until the thunk is called.

func (*UserSliceLoader) Prime

func (l *UserSliceLoader) Prime(key int, value []example.User) bool

Prime the cache with the provided key and value. If the key already exists, no change is made and false is returned. (To forcefully prime the cache, clear the key first with loader.clear(key).prime(key, value).)

type UserSliceLoaderConfig

type UserSliceLoaderConfig struct {
	// Fetch is a method that provides the data for the loader
	Fetch func(keys []int) ([][]example.User, []error)

	// Wait is how long wait before sending a batch
	Wait time.Duration

	// MaxBatch will limit the maximum number of keys to send in one batch, 0 = not limit
	MaxBatch int
}

UserSliceLoaderConfig captures the config to create a new UserSliceLoader