feat(rust): rust sdk docs by flippedcoder · Pull Request #4412 · temporalio/documentation

flippedcoder · 2026-04-08T19:15:29Z

What does this PR do?

This adds the docs for the Rust SDK.

Notes to reviewers

┆Attachments: EDU-6184 feat(rust): rust sdk docs

vercel · 2026-04-08T19:15:37Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
temporal-documentation	Error		Apr 27, 2026 8:57pm

github-actions · 2026-04-08T19:15:58Z

chris-olszewski

Partial review

chris-olszewski · 2026-04-14T19:43:38Z

+    let connection_options =
+        ConnectionOptions::new(Url::from_str("http://localhost:7233")?).build();


It might make sense to funnel users towards envconfig:
https://github.com/temporalio/sdk-core/blob/00d3888adc36d4fab36cca3fdd8426c199ab669d/crates/sdk/examples/hello_world/worker.rs#L18

chris-olszewski · 2026-04-14T20:32:02Z

+
+**How to define Activity parameters using the Temporal Rust SDK.**
+
+There is no explicit limit to the total number of parameters that an [Activity Definition](/activity-definition) may support. However, there is a limit to the total size of the data that ends up encoded into a gRPC message Payload.


For Rust we actually have a hard cap of 6 parameters for activities.

chris-olszewski · 2026-04-14T20:46:20Z

+
+We recommend that you use a single struct as an argument that wraps all the application data passed to Activities. This way you can change what data is passed to the Activity without breaking the function signature.
+
+Activity parameters must be serializable and deserializable using serde. Use `#[derive(Serialize, Deserialize)]` on your data types:


This isn't a hard requirement, but implementing the serde traits are the easiest way to ensure they work. If they have a protobuf message they can leverage ProstSerializable for encoding without implementing the serde traits.

I am actively working on improving the ergonomics of using protobuf instead of serde, so I don't have a good sample yet.

Sushisource

I think we've got to figure out a way to make sure we're actually compiling code snippets going directly into docs, because a lot of these would fail to compile.

Super happy to see the progress here, but, we need some automated gates around this AI-generated code otherwise we're going to frustrate a lot of users.

Sushisource · 2026-04-24T15:55:38Z

+- Be `async` (return a future)
+- Take `ActivityContext` as the first parameter
+- Return `Result<T, ActivityError>` where `T` is the return type
+- Be `pub` (public)
+


This doesn't mention activities that can take Arc<Self> and be registered using an instance. We should have an example of that somewhere as well.

Sushisource · 2026-04-24T15:56:34Z

+### Define Activity return values {#activity-return-values}
+
+**How to define Activity return values using the Temporal Rust SDK.**


I'd probably just combine this and the above section since they're really dealing with the same concept.

Sushisource · 2026-04-24T15:57:36Z

+Activities return `Result<T, ActivityError>` with different error types for different failure scenarios:
+
+- **`ActivityError::Retryable`** - Transient failure that should be retried according to the Activity's retry policy
+- **`ActivityError::NonRetryable`** - Permanent failure that will not be retried
+- **`ActivityError::Cancelled`** - Activity was cancelled by the Workflow


This section should probably refer to what the default behavior is for errors bubbled up via ?

(Which I believe is to convert them into a Retryable activity error)

Sushisource · 2026-04-24T16:00:20Z

+        start_to_close_timeout: Some(Duration::from_secs(10)),
+        // How long to wait before retrying a failed Activity
+        schedule_to_close_timeout: Some(Duration::from_secs(60)),


Activity options changed recently so that we require one or both of these timeouts at the type level, this file will need some updates

Sushisource · 2026-04-24T21:33:11Z

+        // Wait for both to complete
+        let result1 = future1.await?;
+        let result2 = future2.await?;


This should use our join! helper

Sushisource · 2026-04-24T21:37:22Z

+    // How many Workflow tasks to poll concurrently
+    .max_concurrent_workflow_task_polls(10)
+    // How many Activity tasks to poll concurrently
+    .max_concurrent_activity_task_polls(10)
+    // How long to wait for tasks from the service
+    .pollers_config(PollerConfig {
+        max_tasks_per_poll: 100,
+        ..Default::default()
+    })


All these options are fabricated. xxx_task_poller_behavior is the actual name

Sushisource · 2026-04-24T21:38:29Z

+
+## Scale Workers Horizontally {#scale-workers}
+
+You can run multiple Worker processes on different machines, all listening to the same Task Queue:


You could but there's essentially zero reason to do so. We should remove this section.

Sushisource · 2026-04-24T21:41:05Z

+    tokio::select! {
+        _ = worker.run() => println!("Worker stopped"),
+        _ = signal::ctrl_c() => {
+            println!("Received shutdown signal, gracefully shutting down...");
+            // Worker will complete in-flight tasks
+        }
+    }


This will cause us to just stop caring about the worker's run function, which is not what we want, and will mean shutdown is not graceful.

This code needs to instead spawn a task that listens for ctrl_c, and if received, calls the function returned by shutdown_handle() on the worker.

Then, run is always awaited until conclusion

Sushisource · 2026-04-24T21:44:43Z

+
+## Define Workflow parameters {#workflow-parameters}
+
+Temporal Workflows may have any number of custom parameters. However, we strongly recommend that objects are used as parameters, so that the object's individual fields may be altered without breaking the signature of the Workflow. All Workflow Definition parameters must be serializable.


Suggested change

Temporal Workflows may have any number of custom parameters. However, we strongly recommend that objects are used as parameters, so that the object's individual fields may be altered without breaking the signature of the Workflow. All Workflow Definition parameters must be serializable.

Temporal Workflows may have any number of custom parameters. However, we strongly recommend that structs are used as parameters, so that the object's individual fields may be altered without breaking the signature of the Workflow. All Workflow Definition parameters must be serializable.

Sushisource · 2026-04-24T21:49:26Z

+            ..Default::default()
+        };
+
+        let started = ctx.child_workflow(child_opts).start().await.into_started().unwrap();


Neither start() nor into_started() exist

Co-authored-by: Chris Olszewski <chrisdolszewski@gmail.com>

vercel Bot had a problem deploying to Preview April 8, 2026 19:15 Failure

flippedcoder force-pushed the mm/rust-sdk branch from 658bb46 to 5599ed2 Compare April 9, 2026 14:44

vercel Bot had a problem deploying to Preview April 9, 2026 14:48 Failure

flippedcoder force-pushed the mm/rust-sdk branch from 5599ed2 to 8ed93c7 Compare April 10, 2026 16:08

vercel Bot had a problem deploying to Preview April 10, 2026 16:09 Failure

vercel Bot had a problem deploying to Preview April 13, 2026 16:11 Failure

flippedcoder force-pushed the mm/rust-sdk branch 2 times, most recently from adb4a7a to 3d673be Compare April 13, 2026 16:18

vercel Bot had a problem deploying to Preview April 13, 2026 16:19 Failure

flippedcoder force-pushed the mm/rust-sdk branch from 3d673be to d6eb0bd Compare April 13, 2026 16:20

vercel Bot had a problem deploying to Preview April 13, 2026 16:21 Failure

flippedcoder force-pushed the mm/rust-sdk branch from d6eb0bd to bcd3c34 Compare April 13, 2026 16:25

vercel Bot deployed to Preview April 13, 2026 16:26 View deployment

vercel Bot deployed to Preview April 14, 2026 17:40 View deployment

flippedcoder force-pushed the mm/rust-sdk branch from 2cb46fa to de03821 Compare April 14, 2026 17:52

flippedcoder marked this pull request as ready for review April 14, 2026 17:52

flippedcoder requested a review from a team as a code owner April 14, 2026 17:52

vercel Bot deployed to Preview April 14, 2026 17:54 View deployment

chris-olszewski reviewed Apr 14, 2026

View reviewed changes

jsundai reviewed Apr 16, 2026

View reviewed changes

Comment thread docs/develop/rust/nexus/service-handler.mdx Outdated

jsundai reviewed Apr 16, 2026

View reviewed changes

Comment thread docs/develop/rust/workflows/timers.mdx Outdated

jsundai reviewed Apr 16, 2026

View reviewed changes

Comment thread docs/develop/rust/index.mdx

jsundai reviewed Apr 16, 2026

View reviewed changes

Comment thread sidebars.js

vercel Bot deployed to Preview April 16, 2026 13:59 View deployment

flippedcoder force-pushed the mm/rust-sdk branch from bd0fa79 to a777017 Compare April 17, 2026 19:36

vercel Bot deployed to Preview April 17, 2026 19:37 View deployment

vercel Bot deployed to Preview April 17, 2026 19:44 View deployment

vercel Bot deployed to Preview April 21, 2026 18:44 View deployment

vercel Bot deployed to Preview April 24, 2026 19:27 View deployment

vercel Bot deployed to Preview April 24, 2026 20:51 View deployment

Sushisource reviewed Apr 24, 2026

View reviewed changes

vercel Bot deployed to Preview April 27, 2026 14:19 View deployment

vercel Bot had a problem deploying to Preview April 27, 2026 18:00 Failure

vercel Bot had a problem deploying to Preview April 27, 2026 18:10 Failure

vercel Bot had a problem deploying to Preview April 27, 2026 19:39 Failure

flippedcoder and others added 20 commits April 27, 2026 15:56

feat(rust): outline for rust sdk docs

312f639

feat(rust): initial draft of sdk docs

6f1f7b7

feat(rust): updated quickstart to work

d3a377a

feat(rust): minor clean up for workflow basics

492e3ca

chore(rust): added terminal output for quickstart

1530712

Update docs/develop/rust/activities/basics.mdx

d35799d

Co-authored-by: Chris Olszewski <chrisdolszewski@gmail.com>

feat(rust): updated nexus service handler name

0a4fb7b

feat(rust): updated initial draft of workflow basics

ef874e5

chore(rust): updated code snippets to remove unnecessary workflow::

ad9ba43

feat(rust): initial review of child workflow text and code

192ed8d

feat(rust): updated continue-as-new draft

6944b17

feat(rust): updated message passing draft and code snippets

5a1bbae

feat(rust): updated cancellation draft

cc6331f

feat(rust): updated timers draft

7cc66c1

feat(rust): updated activity basics draft

b696dce

feat(rust): updated activity execution draft

026f5bd

feat(rust): added workflow timeouts and activity timeouts

a737670

feat(rust): updated worker process draft

9f475d3

feat(rust): updated client draft

b621e23

feat(rust): updated nexus draft

f03f68d

vercel Bot had a problem deploying to Preview April 27, 2026 20:56 Failure

flippedcoder force-pushed the mm/rust-sdk branch from 1120fd3 to f03f68d Compare April 27, 2026 20:56

vercel Bot had a problem deploying to Preview April 27, 2026 20:57 Failure

		let connection_options =
		ConnectionOptions::new(Url::from_str("http://localhost:7233")?).build();


		How to define Activity parameters using the Temporal Rust SDK.

		There is no explicit limit to the total number of parameters that an [Activity Definition](/activity-definition) may support. However, there is a limit to the total size of the data that ends up encoded into a gRPC message Payload.


		We recommend that you use a single struct as an argument that wraps all the application data passed to Activities. This way you can change what data is passed to the Activity without breaking the function signature.

		Activity parameters must be serializable and deserializable using serde. Use `#[derive(Serialize, Deserialize)]` on your data types:

		### Define Activity return values {#activity-return-values}

		How to define Activity return values using the Temporal Rust SDK.


		## Scale Workers Horizontally {#scale-workers}

		You can run multiple Worker processes on different machines, all listening to the same Task Queue:


		## Define Workflow parameters {#workflow-parameters}

		Temporal Workflows may have any number of custom parameters. However, we strongly recommend that objects are used as parameters, so that the object's individual fields may be altered without breaking the signature of the Workflow. All Workflow Definition parameters must be serializable.

Conversation

flippedcoder commented Apr 8, 2026 • edited by sync-by-unito Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

Notes to reviewers

Uh oh!

vercel Bot commented Apr 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Apr 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📖 Docs PR preview links

Uh oh!

chris-olszewski left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Sushisource left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

flippedcoder commented Apr 8, 2026 •

edited by sync-by-unito Bot

Loading

vercel Bot commented Apr 8, 2026 •

edited

Loading

github-actions Bot commented Apr 8, 2026 •

edited

Loading