par

Documentation

Overview

Package par implements parallel execution helpers.

Index

• type Cache
  • func (c *Cache) Clear()
  • func (c *Cache) Delete(key interface{})
  • func (c *Cache) DeleteIf(pred func(key interface{}) bool)
  • func (c *Cache) Do(key interface{}, f func() interface{}) interface{}
  • func (c *Cache) Get(key interface{}) interface{}
• type Work
  • func (w *Work) Add(item interface{})
  • func (w *Work) Do(n int, f func(item interface{}))

Types

type Cache

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

Cache runs an action once per key and caches the result.

func (*Cache) Clear

func (c *Cache) Clear()

Clear removes all entries in the cache.

Concurrent calls to Get may return old values. Concurrent calls to Do may return old values or store results in entries that have been deleted.

TODO(jayconrod): Delete this after the package cache clearing functions in internal/load have been removed.

func (*Cache) Delete

func (c *Cache) Delete(key interface{})

Delete removes an entry from the map. It is safe to call Delete for an entry that does not exist. Delete will return quickly, even if the result for a key is still being computed; the computation will finish, but the result won't be accessible through the cache.

TODO(jayconrod): Delete this after the package cache clearing functions in internal/load have been removed.

func (*Cache) DeleteIf

func (c *Cache) DeleteIf(pred func(key interface{}) bool)

DeleteIf calls pred for each key in the map. If pred returns true for a key, DeleteIf removes the corresponding entry. If the result for a key is still being computed, DeleteIf will remove the entry without waiting for the computation to finish. The result won't be accessible through the cache.

TODO(jayconrod): Delete this after the package cache clearing functions in internal/load have been removed.

func (*Cache) Do

func (c *Cache) Do(key interface{}, f func() interface{}) interface{}

Do calls the function f if and only if Do is being called for the first time with this key. No call to Do with a given key returns until the one call to f returns. Do returns the value returned by the one call to f.

func (*Cache) Get

func (c *Cache) Get(key interface{}) interface{}

Get returns the cached result associated with key. It returns nil if there is no such result. If the result for key is being computed, Get does not wait for the computation to finish.

type Work

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

Work manages a set of work items to be executed in parallel, at most once each. The items in the set must all be valid map keys.

func (*Work) Add

func (w *Work) Add(item interface{})

Add adds item to the work set, if it hasn't already been added.

func (*Work) Do

func (w *Work) Do(n int, f func(item interface{}))

Do runs f in parallel on items from the work set, with at most n invocations of f running at a time. It returns when everything added to the work set has been processed. At least one item should have been added to the work set before calling Do (or else Do returns immediately), but it is allowed for f(item) to add new items to the set. Do should only be used once on a given Work.