evict

Documentation

Overview

Package evict is a helper package for github.com/pulumi/pulumi-go-provider/middleware/cancel.

Index

• type Handle
  • func (h Handle[T]) Evict()
• type Pool
  • func (c *Pool[T]) Close()
  • func (c *Pool[T]) Insert(t T) (ret Handle[T])

Types

type Handle

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

Handle represents an entry in a Pool.

func (Handle[T]) Evict

func (h Handle[T]) Evict()

Evict the entry from the Pool.

type Pool

type Pool[T any] struct {
	OnEvict func(T)
	// contains filtered or unexported fields
}

Pool is a data structure which provides amortized O(1) insertion, removal, and draining.

func (*Pool[T]) Close

func (c *Pool[T]) Close()

Close the cache, evicting all elements and evicting future elements on insertion.

func (*Pool[T]) Insert

func (c *Pool[T]) Insert(t T) (ret Handle[T])

Insert a new element into the Pool. The new element can be ejected by calling `evict`. If the element was already drained or if `evict` was already called, then `evict` will return true. Otherwise it returns false.