Skip to content

docs: add Rust client integration guide#27

Open
nazq wants to merge 2 commits intomainfrom
docs/rust-client-guide
Open

docs: add Rust client integration guide#27
nazq wants to merge 2 commits intomainfrom
docs/rust-client-guide

Conversation

@nazq
Copy link
Copy Markdown
Owner

@nazq nazq commented Nov 28, 2025

Summary

  • Add comprehensive docs/RUST_CLIENT.md for external Rust consumers
  • Covers proto compilation with tonic-build, all 19 RPC methods with code examples
  • Includes Arrow batch processing, mTLS configuration, and error handling
  • Links from README.md and GRPC_MULTIPLEXER.md

Refreshed for current deps:

  • normalize field updated from bool to optional bool (TEI 1.9.2)
  • tonic/prost/tonic-build bumped to 0.14
  • Arrow bumped to v57
  • Added missing tokio-stream dependency

Test plan

  • Verify all code examples compile (syntax checked)
  • Links resolve correctly in rendered markdown

@codecov
Copy link
Copy Markdown

codecov bot commented Nov 28, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.78%. Comparing base (e6d59d6) to head (b1abafb).

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #27      +/-   ##
==========================================
+ Coverage   82.77%   82.78%   +0.01%     
==========================================
  Files          24       24              
  Lines        7139     7139              
==========================================
+ Hits         5909     5910       +1     
+ Misses       1230     1229       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

nazq and others added 2 commits March 4, 2026 12:43
Add comprehensive documentation for external Rust consumers on how to
build a tonic gRPC client using our nested proto structure. Covers proto
compilation, all RPC methods with examples, Arrow batch processing,
mTLS, and error handling.
- Fix normalize field: bool -> optional bool (Some(true)) per TEI 1.9.2
- Bump tonic 0.12 -> 0.14, prost 0.13 -> 0.14, tonic-build 0.12 -> 0.14
- Bump arrow 53 -> 57 to match current lockfile
- Add missing tokio-stream dependency for streaming examples
@nazq nazq force-pushed the docs/rust-client-guide branch from eab0153 to b1abafb Compare March 4, 2026 17:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant