Skip to content

Fix rustapi-grpc documentation for direct usage and add explicit Tokio features#119

Closed
Copilot wants to merge 2 commits intogrpc-and-so-manyfrom
copilot/sub-pr-118
Closed

Fix rustapi-grpc documentation for direct usage and add explicit Tokio features#119
Copilot wants to merge 2 commits intogrpc-and-so-manyfrom
copilot/sub-pr-118

Conversation

Copy link
Contributor

Copilot AI commented Feb 11, 2026

Addresses review feedback from PR #118: rustapi-grpc examples imported from rustapi_rs::grpc, making them unusable for direct crate consumers, and lacked explicit Tokio feature declarations.

Documentation updates:

  • README now distinguishes via-facade vs. direct usage upfront
  • All examples updated to use rustapi_grpc + rustapi_core imports (copy-pasteable for direct users)
  • Crate-level docs lead with direct usage pattern, mention facade as alternative
  • Function doc examples (run_rustapi_and_grpc_with_shutdown) also updated

Dependency improvements:

  • Added explicit Tokio features: rt, sync, macros (follows pattern in rustapi-core, rustapi-extras, rustapi-ws)
  • No longer relies on implicit Tokio defaults or workspace configuration

Before (confusing for direct users):

use rustapi_rs::grpc::{run_rustapi_and_grpc, tonic};
use rustapi_rs::prelude::*;

After (works for both direct and facade users):

// Direct usage
use rustapi_grpc::{run_rustapi_and_grpc, tonic};
use rustapi_core::{get, RustApi};

// Or via facade (mentioned in docs)
use rustapi_rs::grpc::{run_rustapi_and_grpc, tonic};

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

- Add explicit Tokio features (rt, sync) to Cargo.toml
- Update crate-level docs to show direct rustapi_grpc usage first
- Add Usage section to README distinguishing rustapi-rs vs direct usage
- Update all examples to use rustapi_grpc + rustapi_core imports

Co-authored-by: Tuntii <121901995+Tuntii@users.noreply.github.com>
Copilot AI changed the title [WIP] Add optional rustapi-grpc crate for gRPC integration Fix rustapi-grpc documentation for direct usage and add explicit Tokio features Feb 11, 2026
Copilot AI requested a review from Tuntii February 11, 2026 13:10
@Tuntii Tuntii closed this Feb 12, 2026
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.

2 participants