Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

substrate

package

Go to main page

Versions in this module

v0

v0.3.0

Oct 22, 2026

Changes in this version

+ var ErrActorBusy = fmt.Errorf("substrate: actor is busy with another operation: %w", api.ErrComputeBusy)

+ var ErrActorExists = errors.New("substrate: actor already exists")

+ var ErrMemoryStateLost = fmt.Errorf("substrate: refusing to cold-create an actor: %w", api.ErrMemoryStateLost)

+ var ErrSnapshotNotReady = fmt.Errorf("%w: newest snapshot has no completed durable copy", ErrSnapshotNotRestorable)

+ var ErrSnapshotNotRestorable = errors.New("substrate: snapshot is not restorable")

type ActorInfo

+ CaptureLineage string

+ MemoryNotRestored bool

+ NoCapture bool

+ NoSnapshotHistory bool

+ SnapshotFidelity SnapshotFidelity

+ SnapshotNotReady bool

+ SnapshotPending bool

+ UID string

type ActorStatus

+ const StatusTransitioning

+ func (s ActorStatus) String() string

type Backend

+ func (b *Backend) RestoreInstance(ctx context.Context, ref api.SnapshotRef, recorded func() (string, error)) (inc api.Incarnation, err error)

type Option

+ func WithVolumesOnly() Option

+ type SnapshotFidelity int

+ const SnapshotFidelityMemory

+ const SnapshotFidelityRootFS

+ const SnapshotFidelityUnknown

+ const SnapshotFidelityVolumes

+ func (f SnapshotFidelity) String() string

v0.2.0

Oct 16, 2026

Changes in this version

+ const DefaultRouterAddress

+ const HarnessPort

+ const TargetActorHeader

+ var ErrActorNotFound = errors.New("substrate: actor not found")

+ var ErrNoSnapshotToClone = errors.New("substrate: fork of a memory-snapshot harness needs a parent snapshot")

+ var ErrSnapshotSuperseded = fmt.Errorf("substrate: parent snapshot was superseded before the fork could tag it: %w", ...)

+ var ErrTagExists = errors.New("substrate: tag already exists")

+ type ActorInfo struct

+ Snapshot string

+ Status ActorStatus

+ Worker string

+ type ActorRef struct

+ Atespace string

+ Name string

+ type ActorStatus int

+ const StatusRunning

+ const StatusSuspended

+ const StatusTerminated

+ const StatusUnknown

+ type Backend struct

+ func New(ctl ControlClient, atespace string, template ObjectRef, ...) *Backend

+ func (b *Backend) Capabilities() api.RuntimeCapabilities

+ func (b *Backend) Create(ctx context.Context, s *api.SessionSpec) (inc api.Incarnation, err error)

+ func (b *Backend) Describe(ctx context.Context) (api.Descriptor, error)

+ func (b *Backend) Fork(ctx context.Context, ref api.SnapshotRef, opts api.ForkOpts) (inc api.Incarnation, err error)

+ func (b *Backend) Restore(ctx context.Context, ref api.SnapshotRef) (inc api.Incarnation, err error)

+ func (b *Backend) Snapshot(ctx context.Context, in api.Incarnation, kind api.SnapshotKind) (snapshot api.SnapshotRef, err error)

+ func (b *Backend) Status(ctx context.Context, in api.Incarnation) (state api.ComputeState, err error)

+ func (b *Backend) Stop(ctx context.Context, in api.Incarnation) (err error)

+ type ControlClient interface

+ CreateActor func(ctx context.Context, actor ActorRef, template ObjectRef) error

+ DeleteActor func(ctx context.Context, actor ActorRef) error

+ GetActor func(ctx context.Context, actor ActorRef) (ActorInfo, error)

+ ResumeActor func(ctx context.Context, actor ActorRef) (ActorInfo, error)

+ SuspendActor func(ctx context.Context, actor ActorRef) (snapshot string, err error)

+ type ObjectRef struct

+ Atespace string

+ Name string

+ type Option func(*Backend)

+ func WithLogger(logger *slog.Logger) Option

+ func WithRouter(address string) Option

+ type SnapshotCloner interface

+ CreateActorFromTag func(ctx context.Context, actor ActorRef, template ObjectRef, tag SnapshotID) error

+ DeleteTag func(ctx context.Context, tag SnapshotID) error

+ TagActor func(ctx context.Context, source ActorRef, tag SnapshotID) error

+ type SnapshotID struct

+ Atespace string

+ Name string