---
title: "Client"
description: "This page lists the Rust SDK names for the Client."
canonical_url: "https://docs.superdurable.io/zh-Hans/reference/rust/client/"
source: "docs/reference/rust/client.mdx"
locale: "zh-Hans"
---

# Client

This page lists the Rust SDK names for the [Client](https://docs.superdurable.io/zh-Hans/concepts/client.md).
The doc comment of each API gives its parameters, defaults, and errors. Read
them in the [Rust SDK API reference](https://docs.superdurable.io/zh-Hans/reference/rust.md#api-reference).

<a id="api-names"></a>

## API names

| Task                                  | Rust API                                                                                                                  | Dex behavior                                                                                                                       |
| ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| Create a Client                       | **Client::try_new** or **Client::new**, with **Registry**, **BlobCache**, and **ClientOptions**                           | [Client requests](https://docs.superdurable.io/zh-Hans/reference/server/runtime-client.md)                                         |
| Start a Flow                          | **start_flow**, or **start_flow_with_options** with **StartFlowOptions**                                                  | [Start a Flow](https://docs.superdurable.io/zh-Hans/reference/server/runtime-client.md#start-a-flow)                               |
| Invoke an RPC                         | **invoke_rpc** and **invoke_rpc_without_input**                                                                           | [Invoke an RPC](https://docs.superdurable.io/zh-Hans/reference/server/runtime-client.md#invoke-an-rpc)                             |
| Read Attributes                       | **get_attributes**                                                                                                        | [Read Attributes](https://docs.superdurable.io/zh-Hans/reference/server/runtime-client.md#read-attributes)                         |
| Wait for a Flow to close              | **wait_for_flow** and **wait_for_flow_with_timeout**                                                                      | [Wait for a Flow](https://docs.superdurable.io/zh-Hans/reference/server/runtime-client.md#wait-for-a-flow)                         |
| Wait for a Step execution to complete | **wait_for_step_completion**, with **WaitForStepCompletionOptions**                                                       | [Wait for a Step](https://docs.superdurable.io/zh-Hans/reference/server/runtime-client.md#wait-for-a-step)                         |
| Wait until an Attribute matches       | **wait_for_attribute_match** and **wait_for_attribute_map_instance_match**, with **WaitForAttributeOptions**              | [Wait for an Attribute match](https://docs.superdurable.io/zh-Hans/reference/server/runtime-client.md#wait-for-an-attribute-match) |
| Describe a Flow                       | **describe_flow**                                                                                                         | [Describe a Flow](https://docs.superdurable.io/zh-Hans/reference/server/runtime-client.md#describe-a-flow)                         |
| Search Flows                          | **search_flows**, **search_flows_page**, and **search_flows_with_options**                                                | [Search Flows](https://docs.superdurable.io/zh-Hans/reference/server/runtime-client.md#search-flows)                               |
| Stop a Flow                           | **stop_flow**, with **StopFlowOptions**                                                                                   | [Stop a Flow](https://docs.superdurable.io/zh-Hans/reference/server/runtime-client.md#stop-a-flow)                                 |
| Skip a Timer                          | **skip_timer**                                                                                                            | [Skip a Timer](https://docs.superdurable.io/zh-Hans/reference/server/runtime-client.md#skip-a-timer)                               |
| Update FlowConfig                     | **update_flow_config**                                                                                                    | [Update FlowConfig](https://docs.superdurable.io/zh-Hans/reference/rust/flow.md#update-flow-config-with-a-client)                  |
| Write and read a Stream               | **write_stream**, **read_stream**, and **list_stream_messages**                                                           | [Stream](https://docs.superdurable.io/zh-Hans/reference/rust/stream.md)                                                            |
| Upload Flow definitions               | **upload_flow_definitions**, with **FlowDefinitionDocument**; returns **FlowDefinitionUploadResult** values. Since 1.45.0 | [Flow definitions](https://docs.superdurable.io/zh-Hans/reference/server/runtime-client.md#flow-definitions)                       |
| Time travel a Flow                    | **time_travel**, with **TimeTravelOptions**                                                                               | [Time travel](https://docs.superdurable.io/zh-Hans/reference/server/runtime-client.md#time-travel)                                 |
| Handle a failed request               | **SdkError**, with **ServiceError** and **ErrorSubStatus**                                                                | [Client requests](https://docs.superdurable.io/zh-Hans/reference/server/runtime-client.md)                                         |

Every **Client** method blocks the calling thread. An internal Tokio runtime
performs the requests.

<a id="example"></a>

## Example

Example: [examples/rust/src/primitives/client_apis/controller.rs](https://github.com/superdurable/dex/tree/main/examples/rust/src/primitives/client_apis/controller.rs)
