durable

package module

Go to main page

Versions in this module

v0

v0.1.4

Sep 16, 2026

Changes in this version

type Engine

+ func (e *Engine) LoadInput(ctx context.Context, taskID, runID string) ([]byte, bool, error)

type ReadOnlyEngine

+ func (r *ReadOnlyEngine) LoadInput(ctx context.Context, taskID, runID string) ([]byte, bool, error)

type StepOption

+ func WithStepVersion(v string) StepOption

type StepRecord

+ Input []byte

+ Version string

v0.1.3

Sep 13, 2026

retracted

Changes in this version

+ var ErrRunCancelled = errors.New("durable: run was cancelled")

type Engine

+ func (e *Engine) CancelRun(ctx context.Context, taskID, runID string) error

+ func (e *Engine) GetStep(ctx context.Context, taskID, runID, stepID string) (StepRecord, bool, error)

+ func (e *Engine) WatchSteps(ctx context.Context, taskID, runID string, fromOffset int, ...) (<-chan StepEvent, error)

type ReadOnlyEngine

+ func (r *ReadOnlyEngine) GetStep(ctx context.Context, taskID, runID, stepID string) (StepRecord, bool, error)

+ type StepEvent struct

+ ByteOffset int64

+ Offset int

type StepRun

+ func (r *StepRun[O]) Done() <-chan struct{}

type StepStatus

+ const StepStatusRunning

v0.1.2

Sep 8, 2026

retracted

Changes in this version

+ var ErrEngineLocked = errors.New("durable: dataDir locked by another engine")

+ var ErrInvalidRunID = errors.New("durable: invalid run ID")

+ var ErrInvalidToken = errors.New("durable: invalid step token")

+ var ErrRunActive = errors.New("durable: run is currently executing")

+ var ErrRunAlreadyFinished = errors.New("durable: run already completed or failed")

+ var ErrStepPending = errors.New("durable: step pending external completion")

+ var ErrTaskAlreadyRegistered = errors.New("durable: task already registered")

+ var ErrTaskNotRegistered = errors.New("durable: task not registered")

+ func CompleteStep[O any](ctx context.Context, e *Engine, token string, result O) error

+ func RegisterTask[I, O any](e *Engine, taskID string, task Task[I, O], opts ...TaskOption) error

+ type Engine struct

+ func NewEngine(ctx context.Context, dataDir string, opts ...EngineOption) (*Engine, error)

+ func (e *Engine) Close() error

+ func (e *Engine) DeleteTask(ctx context.Context, taskID string) error

+ func (e *Engine) DeleteTaskRun(ctx context.Context, taskID, runID string) error

+ func (e *Engine) GetTask(ctx context.Context, taskID, runID string) (TaskInfo, bool, error)

+ func (e *Engine) ListTasks(ctx context.Context, statuses ...TaskStatus) ([]TaskInfo, error)

+ func (e *Engine) LoadSteps(ctx context.Context, taskID, runID string) ([]StepRecord, error)

+ type EngineOption func(*engineConfig)

+ func WithLockTimeout(d time.Duration) EngineOption

+ type ReadOnlyEngine struct

+ func NewReadOnlyEngine(dataDir string, opts ...ReadOnlyOption) (*ReadOnlyEngine, error)

+ func (r *ReadOnlyEngine) Close() error

+ func (r *ReadOnlyEngine) GetTask(ctx context.Context, taskID, runID string) (TaskInfo, bool, error)

+ func (r *ReadOnlyEngine) ListTasks(ctx context.Context, statuses ...TaskStatus) ([]TaskInfo, error)

+ func (r *ReadOnlyEngine) LoadSteps(ctx context.Context, taskID, runID string) ([]StepRecord, error)

+ type ReadOnlyOption func(*readOnlyConfig)

+ func WithROLockTimeout(d time.Duration) ReadOnlyOption

+ func WithROLogger(l *slog.Logger) ReadOnlyOption

+ type RunOption func(*runConfig)

+ func WithRunMaxRetries(n int) RunOption

+ func WithRunTimeout(d time.Duration) RunOption

+ type StepOption func(*stepConfig)

+ func WithStepMaxRetries(n int) StepOption

+ func WithStepTimeout(d time.Duration) StepOption

+ type StepRun struct

+ func RunStep[O any](ctx context.Context, s *StepRunner, stepID string, ...) *StepRun[O]

+ func (r *StepRun[O]) Get(ctx context.Context) (O, error)

+ func (r *StepRun[O]) StepID() string

type StepRunner

+ func (s *StepRunner) Logger() *slog.Logger

+ func (s *StepRunner) RunID() string

+ func (s *StepRunner) StepSeq() int

+ func (s *StepRunner) StepToken() string

+ func (s *StepRunner) TaskID() string

type StepStatus

+ const StepStatusWaiting

type TaskInfo

+ RunID string

+ TaskID string

type TaskOption

+ func WithTaskMaxRetries(n int) TaskOption

+ func WithTaskTimeout(d time.Duration) TaskOption

+ type TaskRun struct

+ func RunTask[I, O any](ctx context.Context, e *Engine, taskID string, runID string, input I, ...) *TaskRun[O]

+ func (r *TaskRun[O]) Get(ctx context.Context) (O, error)

+ func (r *TaskRun[O]) RunID() string

+ func (r *TaskRun[O]) Status() TaskStatus

type TaskStatus

+ const StatusWaiting

v0.1.1

Sep 6, 2026

retracted

Changes in this version

type TaskInfo

+ func ListStaleTasks(ctx context.Context, store Store, staleSince time.Duration) ([]TaskInfo, error)

v0.1.0

Sep 6, 2026

retracted

Changes in this version

+ func Run[I, O any](ctx context.Context, h *TaskHandle, input I, task Task[I, O]) (O, error)

+ func Step[O any](ctx context.Context, s *StepRunner, stepID string, ...) (O, error)

+ type Client struct

+ func NewClient(ctx context.Context, store Store, opts ...Option) (*Client, error)

+ func (c *Client) Close() error

+ func (c *Client) NewTask(id string, opts ...TaskOption) *TaskHandle

+ type Option func(*config)

+ func WithAutoPurge(age time.Duration, interval ...time.Duration) Option

+ func WithLogger(logger *slog.Logger) Option

+ type StepRecord struct

+ CompletedAt time.Time

+ Error string

+ InputHash string

+ PanicTrace string

+ Result []byte

+ Seq int

+ StartedAt time.Time

+ Status StepStatus

+ StepID string

+ type StepRunner struct

+ type StepStatus string

+ const StepStatusCompleted

+ const StepStatusFailed

+ const StepStatusPending

+ type Store interface

+ DeleteTask func(ctx context.Context, taskID string) error

+ GetTask func(ctx context.Context, taskID string) (TaskInfo, bool, error)

+ ListStepIDs func(ctx context.Context, taskID string) ([]string, error)

+ ListTasks func(ctx context.Context) ([]TaskInfo, error)

+ LoadStep func(ctx context.Context, taskID, stepID string) (StepRecord, bool, error)

+ LoadSteps func(ctx context.Context, taskID string) ([]StepRecord, error)

+ PurgeTasks func(ctx context.Context, status TaskStatus, before time.Time) (int64, error)

+ SaveStep func(ctx context.Context, taskID string, step StepRecord) error

+ SaveTask func(ctx context.Context, task TaskInfo) error

+ type Task interface

+ Exec func(ctx context.Context, s *StepRunner, input I) (O, error)

+ type TaskFunc func(ctx context.Context, s *StepRunner, input I) (O, error)

+ func Func[I, O any](fn func(ctx context.Context, s *StepRunner, in I) (O, error)) TaskFunc[I, O]

+ func (f TaskFunc[I, O]) Exec(ctx context.Context, s *StepRunner, input I) (O, error)

+ type TaskHandle struct

+ func (h *TaskHandle) ID() string

+ type TaskInfo struct

+ CompletedAt time.Time

+ CreatedAt time.Time

+ Error string

+ ID string

+ Name string

+ PanicTrace string

+ StartedAt time.Time

+ Status TaskStatus

+ Tags map[string]string

+ UpdatedAt time.Time

+ type TaskOption func(*taskConfig)

+ func WithMaxRetries(n int) TaskOption

+ func WithName(name string) TaskOption

+ func WithTag(k, v string) TaskOption

+ func WithTimeout(d time.Duration) TaskOption

+ type TaskStatus string

+ const StatusCompleted

+ const StatusFailed

+ const StatusPending

+ const StatusRunning

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL