From 5bc1aa9371e13883ca1453e75357178e96515906 Mon Sep 17 00:00:00 2001 From: David Pedersen Date: Wed, 14 Apr 2021 09:08:08 +0200 Subject: [PATCH] Mention `rust-analyzer.cargo.loadOutDirsFromCheck` setting in README (#561) Fixes https://github.com/hyperium/tonic/issues/512 --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 0ed6bc5..6ffdcd5 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,9 @@ contains the tools to build clients and servers from [`protobuf`] definitions. Examples can be found in [`examples`] and for more complex scenarios [`interop`] may be a good resource as it shows examples of many of the gRPC features. +If you're using [rust-analyzer] we recommend you set `"rust-analyzer.cargo.loadOutDirsFromCheck": true` to correctly load +the generated code. + ### Rust Version `tonic` currently works on rust `1.39` and above as it requires support for the `async_await` @@ -110,3 +113,4 @@ terms or conditions. [routeguide-tutorial]: https://github.com/hyperium/tonic/blob/master/examples/routeguide-tutorial.md [helloworld-tutorial]: https://github.com/hyperium/tonic/blob/master/examples/helloworld-tutorial.md [healthcheck]: https://github.com/grpc/grpc/blob/master/doc/health-checking.md +[rust-analyzer]: https://rust-analyzer.github.io