Repository files navigation

The official Rust client forConvex.

Convex is the backend application platform with everything you need to buildyour product.

This Rust client can write and read data from a Convex backend with queries,mutations, and actions. Get up and running atdocs.convex.dev.

Join us on Discord to share what you'reworking on or get your questions answered.

Add the following to yourCargo.toml file

[dependencies]convex ="*"

letmut client =ConvexClient::new(DEPLOYMENT_URL).await?;letmut subscription = client.subscribe("getCounter",vec![]).await?;whileletSome(new_val) = subscription.next().await{println!("Counter updated to {new_val:?}");}

Check out the full convex documentation atdocs.convex.dev The rust API docs areavailable ondocs.rs

The Convex rust client works on stable rust 1.71.1 and higher. It also works onnightly.

The Convex Rust Client uses thetracing crate for logging. One commonway of initializing is viatracing_subscriber. Then, you can see debug loggingby running your program withRUST_LOG=convex=debug.

tracing_subscriber::fmt().with_env_filter(tracing_subscriber::EnvFilter::from_default_env()).init();

By default, this will emit all logs, including internal logs from the client.Logs from your Convex backend will show up under theconvex_logs target atLevel=DEBUG. If you want to isolate just those logs, please refer to thetracing_subscriber documentation.