restate

Jun 30, 2026

Changes in this version

+ func IsRetryableError(err error) bool

+ func RejectSignal(ctx Context, invocationID string, name string, reason error)

+ func ResolveSignal[T any](ctx Context, invocationID string, name string, value T, ...)

+ func WithInputCodec(codec encoding.Codec) withInputCodec

+ func WithLimitKey(limitKey string) withLimitKey

+ func WithOutputCodec(codec encoding.Codec) withOutputCodec

+ func WithScope(scope string) withScope

+ type ErrorCodeOption = errors.CodeOption

+ type MockableContext = restatecontext.Context

+ type ResolveSignalOption = options.ResolveSignalOption

+ type RetryableError = errors.RetryableError

+ func AsRetryableError(err error) RetryableError

+ func RetryableErrorf(format string, a ...any) RetryableError

+ func ToRetryableError(err error, opts ...RetryableErrorOption) RetryableError

+ type RetryableErrorOption = errors.RetryableErrorOption

+ type SignalFuture interface

+ Result func() (T, TerminalError)

+ func Signal[T any](ctx Context, name string, options ...options.SignalOption) SignalFuture[T]

+ type SignalOption = options.SignalOption

+ type StringMap = stringmap.Map

type TerminalError

+ func AsTerminalError(err error) TerminalError

+ func ToTerminalError(err error, opts ...TerminalErrorOption) TerminalError

+ type TerminalErrorOption = errors.TerminalErrorOption

Jan 5, 2026

Changes in this version

+ func WithValue[T Context](restateCtx T, key, val any) T

+ func WrapContext[T Context](restateCtx T, wrappedCtx context.Context) T

Nov 19, 2025

Changes in this version

+ func RunVoid(ctx Context, fn func(ctx RunContext) error, options ...options.RunOption) error

Oct 20, 2025

Changes in this version

+ func RandSource(ctx Context) rand2.Source

+ func UUID(ctx Context) uuid.UUID

+ func Wait(ctx Context, futs ...Future) iter.Seq2[Future, error]

+ type Future = restatecontext.Selectable

+ func WaitFirst(ctx Context, futs ...Future) (resultFut Future, cancellationError error)

+ type WaitIterator = restatecontext.WaitIterator

+ func WaitIter(ctx Context, futs ...Future) WaitIterator

Sep 16, 2025

Changes in this version

+ func KillOnMaxAttempts() options.InvocationRetryPolicyOption

+ func PauseOnMaxAttempts() options.InvocationRetryPolicyOption

+ func WithExponentiationFactor(f float64) options.InvocationRetryPolicyOption

+ func WithInitialInterval(d time.Duration) options.InvocationRetryPolicyOption

+ func WithInvocationRetryPolicy(opts ...InvocationRetryPolicyOption) withInvocationRetryPolicy

+ func WithMaxAttempts(n int) options.InvocationRetryPolicyOption

+ func WithMaxInterval(d time.Duration) options.InvocationRetryPolicyOption

+ type InvocationRetryPolicy = options.InvocationRetryPolicy

+ type InvocationRetryPolicyOption = options.InvocationRetryPolicyOption

+ type OnMaxAttempts = options.OnMaxAttempts

type ServiceDefinition

+ ConfigureHandler func(name string, opts ...options.HandlerOption) ServiceDefinition

Aug 18, 2025

Changes in this version

+ type AttachOption = options.AttachOption

+ type AwakeableOption = options.AwakeableOption

+ type GetOption = options.GetOption

+ type HandlerOption = options.HandlerOption

+ type IngressClientOption = options.IngressClientOption

+ type IngressRequestOption = options.IngressRequestOption

+ type IngressSendOption = options.IngressSendOption

+ type PromiseOption = options.PromiseOption

+ type RequestOption = options.RequestOption

+ type ResolveAwakeableOption = options.ResolveAwakeableOption

+ type RunOption = options.RunOption

+ type SendOption = options.SendOption

+ type SetOption = options.SetOption

+ type SleepOption = options.SleepOption

Jul 2, 2025

Changes in this version

+ func WithAbortTimeout(abortTimeout time.Duration) withAbortTimeout

+ func WithAuthKey(authKey string) withAuthKey

+ func WithEnableLazyState(enableLazyState bool) withEnableLazyState

+ func WithHttpClient(c *http.Client) withHttpClient

+ func WithIdempotencyRetention(idempotencyRetention time.Duration) withIdempotencyRetention

+ func WithInactivityTimeout(inactivityTimeout time.Duration) withInactivityTimeout

+ func WithIngressPrivate(ingressPrivate bool) withIngressPrivate

+ func WithJournalRetention(journalRetention time.Duration) withJournalRetention

+ func WithWorkflowRetention(workflowCompletionRetention time.Duration) withWorkflowRetention

Apr 29, 2025

Changes in this version

+ type RunAsyncFuture interface

+ Result func() (T, error)

+ func RunAsync[T any](ctx Context, fn func(ctx RunContext) (T, error), options ...options.RunOption) RunAsyncFuture[T]

Apr 9, 2025

Changes in this version

+ func CancelInvocation(ctx Context, invocationId string)

+ func WithDocumentation(documentation string) withDocumentation

+ func WithIdempotencyKey(idempotencyKey string) withIdempotencyKey

+ func WithInitialRetryInterval(initialRetryInterval time.Duration) withInitialRetryInterval

+ func WithMaxRetryAttempts(maxAttempts uint) withMaxRetryAttempts

+ func WithMaxRetryDuration(maxRetryDuration time.Duration) withMaxRetryDuration

+ func WithMaxRetryInterval(maxRetryInterval time.Duration) withMaxRetryInterval

+ func WithMetadata(metadataKey string, metadataValue string) withMetadata

+ func WithMetadataMap(metadata map[string]string) withMetadata

+ func WithName(name string) withName

+ func WithRetryIntervalFactor(retryIntervalFactor float32) withRetryIntervalFactor

+ type AttachFuture interface

+ Response func() (O, error)

+ func AttachInvocation[T any](ctx Context, invocationId string, options ...options.AttachOption) AttachFuture[T]

+ type Invocation = restatecontext.Invocation

type ServiceDefinition

+ GetOptions func() *options.ServiceDefinitionOptions

Feb 12, 2025

Changes in this version

+ func WithMockContext(ctx state.Context) mockContext

Nov 8, 2024

Changes in this version

+ func NewWorkflow(name string, opts ...options.ServiceDefinitionOption) *workflow

+ func NewWorkflowHandler[I any, O any](fn WorkflowHandlerFn[I, O], opts ...options.HandlerOption) *workflowHandler[I, O]

+ func NewWorkflowSharedHandler[I any, O any](fn WorkflowSharedHandlerFn[I, O], opts ...options.HandlerOption) *workflowHandler[I, O]

type Client

+ func Workflow[O any](ctx Context, service string, workflowID string, method string, ...) Client[any, O]

+ type DurablePromise interface

+ Peek func() (T, error)

+ Reject func(reason error) error

+ Resolve func(value T) error

+ Result func() (T, error)

+ func Promise[T any](ctx WorkflowSharedContext, name string, options ...options.PromiseOption) DurablePromise[T]

type SendClient

+ func WorkflowSend[O any](ctx Context, service string, workflowID string, method string, ...) SendClient[any]

+ type WorkflowContext interface

+ type WorkflowHandlerFn func(ctx WorkflowContext, input I) (O, error)

+ type WorkflowSharedContext interface

+ type WorkflowSharedHandlerFn func(ctx WorkflowSharedContext, input I) (O, error)

Aug 22, 2024

Changes in this version

+ func Clear(ctx ObjectContext, key string)

+ func ClearAll(ctx ObjectContext)

+ func Get[T any](ctx ObjectSharedContext, key string, options ...options.GetOption) (output T, err error)

+ func Key(ctx ObjectSharedContext) string

+ func Keys(ctx ObjectSharedContext) ([]string, error)

+ func Rand(ctx Context) *rand.Rand

+ func RejectAwakeable(ctx Context, id string, reason error)

+ func ResolveAwakeable[T any](ctx Context, id string, value T, options ...options.ResolveAwakeableOption)

+ func Run[T any](ctx Context, fn func(ctx RunContext) (T, error), options ...options.RunOption) (output T, err error)

+ func Set[T any](ctx ObjectContext, key string, value T, options ...options.SetOption)

+ func Sleep(ctx Context, d time.Duration) error

+ func TerminalErrorf(format string, a ...any) error

+ func WithDelay(delay time.Duration) withDelay

+ type AfterFuture interface

+ Done func() error

+ type AwakeableFuture interface

+ Id func() string

+ Result func() (T, error)

+ type Client interface

+ Request func(input I, options ...options.RequestOption) (O, error)

+ RequestFuture func(input I, options ...options.RequestOption) ResponseFuture[O]

+ func WithRequestType[I any, O any](inner Client[any, O]) Client[I, O]

+ type ClientOption = options.ClientOption

type Selector

+ func Select(ctx Context, futs ...futures.Selectable) Selector

type SendClient

+ func ObjectSend(ctx Context, service string, key string, method string, ...) SendClient[any]

+ func ServiceSend(ctx Context, service string, method string, options ...options.ClientOption) SendClient[any]

Aug 14, 2024

Changes in this version

+ var WithProtoJSON = WithPayloadCodec(encoding.ProtoJSONCodec)

+ func NewObject(name string, opts ...options.ServiceDefinitionOption) *object

+ func NewService(name string, opts ...options.ServiceDefinitionOption) *service

+ func WithHeaders(headers map[string]string) withHeaders

type CallClient

+ Send func(input any, delay time.Duration) error

+ type CallOption = options.CallOption

+ type ServiceDefinition interface

+ Handlers func() map[string]Handler

+ Name func() string

+ Type func() internal.ServiceType

+ func Reflect(rcvr any, opts ...options.ServiceDefinitionOption) ServiceDefinition

+ type ServiceDefinitionOption = options.ServiceDefinitionOption

type TypedCallClient

+ func NewTypedCallClient[I any, O any](client CallClient) TypedCallClient[I, O]

+ Send func(input I, delay time.Duration) error

Jul 19, 2024

Changes in this version

+ type Code = errors.Code

+ type Request struct

+ AttemptHeaders map[string][]string

+ Body []byte

+ Headers map[string]string

+ ID []byte

type RunContext

+ Request func() *Request

Jul 17, 2024

Changes in this version

+ var ErrKeyNotFound = errors.ErrKeyNotFound

+ var WithBinary = WithPayloadCodec(encoding.BinaryCodec)

+ var WithJSON = WithPayloadCodec(encoding.JSONCodec)

+ var WithProto = WithPayloadCodec(encoding.ProtoCodec)

+ func ErrorCode(err error) errors.Code

+ func GetAs[T any](ctx ObjectSharedContext, key string, options ...options.GetOption) (output T, err error)

+ func IsTerminalError(err error) bool

+ func NewObjectHandler[I any, O any](fn ObjectHandlerFn[I, O], options ...ObjectHandlerOption) *objectHandler[I, O]

+ func NewObjectSharedHandler[I any, O any](fn ObjectSharedHandlerFn[I, O], options ...ObjectHandlerOption) *objectHandler[I, O]

+ func NewServiceHandler[I any, O any](fn ServiceHandlerFn[I, O], options ...ServiceHandlerOption) *serviceHandler[I, O]

+ func RunAs[T any](ctx Context, fn func(RunContext) (T, error), options ...options.RunOption) (output T, err error)

+ func TerminalError(err error, code ...errors.Code) error

+ func WithCodec(codec encoding.Codec) withCodec

+ func WithErrorCode(err error, code errors.Code) error

+ func WithPayloadCodec(codec encoding.PayloadCodec) withPayloadCodec

+ type After interface

+ Done func()

+ type Awakeable interface

+ Id func() string

+ Result func(output any) error

+ type CallClient interface

+ Request func(input any, output any) error

+ RequestFuture func(input any) (ResponseFuture, error)

+ type Context interface

+ After func(d time.Duration) After

+ Awakeable func(options ...options.AwakeableOption) Awakeable

+ Object func(object, key, method string, opts ...options.CallOption) CallClient

+ Rand func() *rand.Rand

+ RejectAwakeable func(id string, reason error)

+ ResolveAwakeable func(id string, value any, options ...options.ResolveAwakeableOption) error

+ Run func(fn func(RunContext) (any, error), output any, opts ...options.RunOption) error

+ Select func(futs ...Selectable) Selector

+ Service func(service, method string, opts ...options.CallOption) CallClient

+ Sleep func(d time.Duration)

+ type Handler interface

+ HandlerType func() *internal.ServiceHandlerType

+ InputPayload func() *encoding.InputPayload

+ OutputPayload func() *encoding.OutputPayload

+ type KeyValueReader interface

+ Get func(key string, value any, options ...options.GetOption) error

+ Key func() string

+ Keys func() []string

+ type KeyValueWriter interface

+ Clear func(key string)

+ ClearAll func()

+ Set func(key string, value any, options ...options.SetOption) error

+ type ObjectContext interface

+ type ObjectHandler interface

+ Call func(ctx ObjectContext, request []byte) (output []byte, err error)

+ type ObjectHandlerFn func(ctx ObjectContext, input I) (O, error)

+ type ObjectHandlerOption interface

+ type ObjectRouter struct

+ func NewObjectRouter(name string, options ...ObjectRouterOption) *ObjectRouter

+ func Object(object any, options ...ObjectRouterOption) *ObjectRouter

+ func (r *ObjectRouter) Handler(name string, handler ObjectHandler) *ObjectRouter

+ func (r *ObjectRouter) Handlers() map[string]Handler

+ func (r *ObjectRouter) Name() string

+ func (r *ObjectRouter) Type() internal.ServiceType

+ type ObjectRouterOption interface

+ type ObjectSharedContext interface

+ type ObjectSharedHandlerFn func(ctx ObjectSharedContext, input I) (O, error)

+ type ResponseFuture interface

+ Response func(output any) error

+ type Router interface

+ Handlers func() map[string]Handler

+ Name func() string

+ Type func() internal.ServiceType

+ type RunContext interface

+ Log func() *slog.Logger

+ type Selectable = futures.Selectable

+ type Selector interface

+ Remaining func() bool

+ Select func() Selectable

+ type SendClient interface

+ Send func(input any, delay time.Duration) error

+ type ServiceHandler interface

+ Call func(ctx Context, request []byte) (output []byte, err error)

+ type ServiceHandlerFn func(ctx Context, input I) (O, error)

+ type ServiceHandlerOption interface

+ type ServiceRouter struct

+ func NewServiceRouter(name string, options ...ServiceRouterOption) *ServiceRouter

+ func Service(service any, options ...ServiceRouterOption) *ServiceRouter

+ func (r *ServiceRouter) Handler(name string, handler ServiceHandler) *ServiceRouter

+ func (r *ServiceRouter) Handlers() map[string]Handler

+ func (r *ServiceRouter) Name() string

+ func (r *ServiceRouter) Type() internal.ServiceType

+ type ServiceRouterOption interface

+ type TypedAwakeable interface

+ Id func() string

+ Result func() (T, error)

+ func AwakeableAs[T any](ctx Context, options ...options.AwakeableOption) TypedAwakeable[T]

+ type TypedCallClient interface

+ Request func(input any) (O, error)

+ RequestFuture func(input any) (TypedResponseFuture[O], error)

+ func CallAs[O any](client CallClient) TypedCallClient[O]

+ type TypedResponseFuture interface

+ Response func() (O, error)

+ type Void = encoding.Void