Skip to content

docs: add Rust client integration guide #27

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nazq wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: add Rust client integration guide #27

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eee4cb4
docs: add Rust client integration guide
nazq Nov 28, 2025
b1abafb
docs: update Rust client guide for TEI 1.9.2 and current deps
github-actions[bot] Mar 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -441,6 +441,7 @@ just pre-commit # Run before committing

- **[DESIGN.md](DESIGN.md)** - Architecture and design decisions
- **[docs/GRPC_MULTIPLEXER.md](docs/GRPC_MULTIPLEXER.md)** - Full gRPC API reference
- **[docs/RUST_CLIENT.md](docs/RUST_CLIENT.md)** - Rust client integration guide
- **[docs/DEPLOYMENT.md](docs/DEPLOYMENT.md)** - Production deployment guide
- **[docs/MTLS.md](docs/MTLS.md)** - mTLS configuration

Expand Down
10 changes: 9 additions & 1 deletion docs/GRPC_MULTIPLEXER.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,15 @@ grpcurl -plaintext localhost:9001 list

### Rust Client Example

For a complete Rust client implementation, see the built-in benchmark client at `src/bin/bench-client.rs`. It demonstrates:
For a complete Rust client integration guide, see **[RUST_CLIENT.md](RUST_CLIENT.md)**. It covers:

- Proto compilation with `tonic-build`
- All RPC methods with code examples
- Arrow batch processing
- mTLS configuration
- Error handling

The built-in benchmark client at `src/bin/bench-client.rs` serves as a reference implementation demonstrating:

- Connecting to the gRPC multiplexer with/without TLS
- Creating Arrow IPC batches with LZ4 compression
Expand Down
Loading