memory

Documentation

Overview

Package memory provides in-process resource adapters for tests and local-first demos.

Index

• type Base
  • func Feature(env, service, name string) *Base
  • func New(id resource.ResourceID, desc resource.Description, ...) *Base
  • func RateLimit(env, service, name string) *Base
  • func Worker(env, service, name string) *Base
  • func (b *Base) AdvanceEpoch(reason string) (resource.EpochAdvance, error)
  • func (b *Base) Capabilities() resource.ResourceCapabilities
  • func (b *Base) Describe() resource.Description
  • func (b *Base) Epoch() resource.ResourceEpoch
  • func (b *Base) Health(ctx context.Context) resource.ResourceHealth
  • func (b *Base) ID() resource.ResourceID
  • func (b *Base) Kind() resource.Kind
  • func (b *Base) Mutate(ctx context.Context, op string, attrs map[string]string) (resource.Evidence, error)
  • func (b *Base) SetHealth(h resource.ResourceHealth)

Types

type Base

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

Base is a simple Resource implementation.

func Feature

func Feature(env, service, name string) *Base

Feature is a KindFeature stub.

func New

func New(id resource.ResourceID, desc resource.Description, caps resource.ResourceCapabilities) *Base

New constructs a Base resource. Capabilities default to SupportsHealth only.

func RateLimit

func RateLimit(env, service, name string) *Base

RateLimit is a KindRateLimit stub.

func Worker

func Worker(env, service, name string) *Base

Worker is a KindWorker stub.

func (*Base) AdvanceEpoch

func (b *Base) AdvanceEpoch(reason string) (resource.EpochAdvance, error)

AdvanceEpoch advances local epoch with reason.

func (*Base) Capabilities

func (b *Base) Capabilities() resource.ResourceCapabilities

func (*Base) Describe

func (b *Base) Describe() resource.Description

func (*Base) Epoch

func (b *Base) Epoch() resource.ResourceEpoch

Epoch returns the in-memory epoch.

func (*Base) Health

func (b *Base) Health(ctx context.Context) resource.ResourceHealth

func (*Base) ID

func (b *Base) ID() resource.ResourceID

func (*Base) Kind

func (b *Base) Kind() resource.Kind

func (*Base) Mutate

func (b *Base) Mutate(ctx context.Context, op string, attrs map[string]string) (resource.Evidence, error)

Mutate implements MutableResource when SupportsOwnership or fencing is claimed; otherwise returns ErrCapabilityClaimed.

func (*Base) SetHealth

func (b *Base) SetHealth(h resource.ResourceHealth)

SetHealth overrides health for tests.