Struct Registry 

pub struct Registry { /* private fields */ }

Implementations

impl Registry

pub fn new() -> Self

pub fn register<A, F, Fut>(&mut self, name: &str, entry: F) -> &mut Self

where A: Actor, F: Fn(Start<A>) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<()>> + Send + 'static,

👎Deprecated:

use register_actor/register_actor_with and implement Actor + Handles instead

pub fn register_actor<A>(&mut self, name: &str) -> &mut Self

where A: Actor,

pub fn register_actor_with<A>( &mut self, name: &str, config: ActorConfig, ) -> &mut Self

where A: Actor,

pub fn register_with<A, F, Fut>( &mut self, name: &str, config: ActorConfig, entry: F, ) -> &mut Self

where A: Actor, F: Fn(Start<A>) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<()>> + Send + 'static,

👎Deprecated:

use register_actor/register_actor_with and implement Actor + Handles instead

pub async fn serve(self, shutdown: CancellationToken) -> Result<()>

pub async fn serve_with_config( self, config: ServeConfig, shutdown: CancellationToken, ) -> Result<()>

pub async fn into_serverless_runtime( self, config: ServeConfig, ) -> Result<CoreServerlessRuntime>

Converts the registry into a serverless runtime. The returned runtime lazily starts an envoy on first request and handles RivetKit serverless HTTP requests (start, metadata, health, metrics) via CoreServerlessRuntime::handle_request. Equivalent to the TypeScript registry.handler entry point for platform fetch handlers.

pub fn prometheus_metrics(&self) -> Result<RenderedMetrics>

Renders the process-global Prometheus metrics. Equivalent to the TypeScript registry.routes.prometheusMetrics(). Metrics are process-global, so this does not depend on registry instance state.

pub async fn start(self) -> Result<()>

Serves actors until the process receives SIGINT or SIGTERM, then cancels and drains. This is the standalone-binary entry point and mirrors the TypeScript registry.start(). Connection settings (including the RIVET_ENGINE_BINARY_PATH used to spawn or reuse a local engine) are read from the environment.

Unlike TypeScript, this blocks until shutdown because Rust has no implicit runtime to keep the process alive. For programmatic lifecycle control (tests, embedding), drive serve with your own CancellationToken instead.

pub async fn start_with_config(self, config: ServeConfig) -> Result<()>

start with an explicit ServeConfig.

Trait Implementations

impl Default for Registry

fn default() -> Self

Returns the “default value” for a type.