Typed Convex clients for Rust

CONVEX-TYPEGEN · V1 DOCUMENTATION

convex-typegen gives Rust the end-to-end type safety TypeScript gets from Convex. Your schema and function signatures become Rust types at build time, so a wrong table, field, argument, or return type is a compile error—not a runtime bug. Schema changes break the Rust build until your code matches.

Build your first project · What's guaranteed and what isn't

Without and with generated types

Official SDK only — string paths, BTreeMap arguments, manual Value decoding:

use std::collections::BTreeMap;

use convex::{ConvexClient, FunctionResult, Value};

let mut client = ConvexClient::new(&url).await?;
let result = client.query("tasks:list", BTreeMap::new()).await?;
let texts: Vec<String> = match result {
    FunctionResult::Value(Value::Array(items)) => items
        .into_iter()
        .filter_map(|item| match item {
            Value::String(text) => Some(text),
            _ => None,
        })
        .collect(),
    _ => return Err("unexpected query result".into()),
};

With convex-typegen — typed paths, args, and returns (same tutorial as first project):

use convex::ConvexClient;
use convex_api::api::tasks;
use convex_typegen_runtime::TypedClient;

let mut sdk = ConvexClient::new(&url).await?;
let mut client = TypedClient::new(&mut sdk);
let texts: Vec<String> = client.query(tasks::list, tasks::ListArgs {}).await?;

The generator reads local TypeScript or a committed function spec at build time. The runtime uses the generated references to encode your arguments and decode Convex results, including IDs, documents, and application errors.

Call and subscribeUse queries, mutations, actions, and live updates. Set up generationChoose your inputs and where Cargo writes the bindings. Read the generated typesUnderstand naming, wire values, and nullable fields. Look up a settingFind build options, CLI flags, defaults, and precedence. Compile-time guaranteesWhat the types enforce—and what still runs on the server.

Rust support: 1.97 for the generator; 1.85 for the runtime with pregenerated bindings. See how generation works for the crate split.

Keyboard shortcuts

convex-typegen

Typed Convex clients for Rust

Without and with generated types