memory

Documentation

Overview

Package memory provides an in-process cache resource for tests and demos.

Index

• type Config
• type Resource
  • func New(cfg Config) (*Resource, error)
  • func (r *Resource) AbortGeneration()
  • func (r *Resource) ActivateGeneration(gen uint64, seed map[string]string) error
  • func (r *Resource) BuildGeneration(_ context.Context) (uint64, error)
  • func (r *Resource) Capabilities() resource.ResourceCapabilities
  • func (r *Resource) Delete(key string)
  • func (r *Resource) Describe() resource.Description
  • func (r *Resource) Generation() uint64
  • func (r *Resource) Get(key string) (string, bool)
  • func (r *Resource) Health(ctx context.Context) resource.ResourceHealth
  • func (r *Resource) ID() resource.ResourceID
  • func (r *Resource) Kind() resource.Kind
  • func (r *Resource) Len() int
  • func (r *Resource) Set(key, value string)
  • func (r *Resource) Snapshot(_ context.Context) (map[string]string, error)

Types

type Config

type Config struct {
	ID          resource.ResourceID
	DisplayName string
}

Config configures the memory cache resource.

type Resource

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

Resource is a full in-process key/value cache with generation control.

func New

func New(cfg Config) (*Resource, error)

New creates an empty memory cache resource.

func (*Resource) AbortGeneration

func (r *Resource) AbortGeneration()

AbortGeneration cancels an in-progress build.

func (*Resource) ActivateGeneration

func (r *Resource) ActivateGeneration(gen uint64, seed map[string]string) error

ActivateGeneration switches to the reserved generation and clears old data.

func (*Resource) BuildGeneration

func (r *Resource) BuildGeneration(_ context.Context) (uint64, error)

BuildGeneration reserves a new generation for rebuild. Call ActivateGeneration after verification. Partial builds never become active until ActivateGeneration.

func (*Resource) Capabilities

func (r *Resource) Capabilities() resource.ResourceCapabilities

func (*Resource) Delete

func (r *Resource) Delete(key string)

Delete removes a key.

func (*Resource) Describe

func (r *Resource) Describe() resource.Description

func (*Resource) Generation

func (r *Resource) Generation() uint64

Generation returns the active cache generation.

func (*Resource) Get

func (r *Resource) Get(key string) (string, bool)

Get returns a value.

func (*Resource) Health

func (r *Resource) Health(ctx context.Context) resource.ResourceHealth

func (*Resource) ID

func (r *Resource) ID() resource.ResourceID

func (*Resource) Kind

func (r *Resource) Kind() resource.Kind

func (*Resource) Len

func (r *Resource) Len() int

Len returns entry count.

func (*Resource) Set

func (r *Resource) Set(key, value string)

Set stores a value in the active generation.

func (*Resource) Snapshot

func (r *Resource) Snapshot(_ context.Context) (map[string]string, error)

Snapshot returns sanitized cache metadata (no values).