Struct HandlerOptions

pub struct HandlerOptions { /* private fields */ }

Various configuration options that can be provided when binding a service handler

Implementations

impl HandlerOptions

pub fn new() -> Self

pub fn metadata(self, key: impl Into<String>, value: impl Into<String>) -> Self

Custom metadata of this handler definition. This metadata is shown on the Admin API when querying the service/handler definition.

pub fn inactivity_timeout(self, timeout: Duration) -> Self

This timer guards against stalled invocations. Once it expires, Restate triggers a graceful termination by asking the invocation to suspend (which preserves intermediate progress).

The abort_timeout is used to abort the invocation, in case it doesn’t react to the request to suspend.

This overrides the inactivity timeout set for the service and the default set in restate-server.

pub fn abort_timeout(self, timeout: Duration) -> Self

This timer guards against stalled invocations that are supposed to terminate. The abort timeout is started after the inactivity_timeout has expired and the invocation has been asked to gracefully terminate. Once the timer expires, it will abort the invocation.

This timer potentially interrupts user code. If the user code needs longer to gracefully terminate, then this value needs to be set accordingly.

This overrides the abort timeout set for the service and the default set in restate-server.

pub fn idempotency_retention(self, retention: Duration) -> Self

The retention duration of idempotent requests to this service.

pub fn workflow_retention(self, retention: Duration) -> Self

The retention duration for this workflow handler.

pub fn journal_retention(self, retention: Duration) -> Self

The journal retention for invocations to this handler.

In case the request has an idempotency key, the idempotency_retention caps the journal retention time.

pub fn ingress_private(self, private: bool) -> Self

When set to true this handler cannot be invoked from the restate-server HTTP and Kafka ingress, but only from other services.

pub fn enable_lazy_state(self, enable: bool) -> Self

When set to true, lazy state will be enabled for all invocations to this handler. This is relevant only for workflows and virtual objects.

Trait Implementations

impl Clone for HandlerOptions

fn clone(&self) -> HandlerOptions

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for HandlerOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for HandlerOptions

fn default() -> HandlerOptions

Returns the “default value” for a type.