Implement IntoFuture trait for RequestBuilder in autorust for autogenerated services #1193
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Implement support for the new std::future::IntoFuture trait on request builder objects.
This eliminates the need to call
into_future()on request builders, as.awaitautomatically invokesinto_future()if theIntoFuturetrait is implemented.This change simplifies the API. However, it is a breaking API change for existing users.
The change requires Rust 1.64.0 or higher. This is enforced via the
rust-versionfield inCargo.tomlfor each of the generated crates.I also updated the documentation for
RequestBuilderto provide more guidance on usage, and to help users locate the return type (which now appears on theIntoFuture::into_future()method in the traits section) . See this example from myazure_devops_rust_apicrate docs for how the final documentation looks.Fixes: #1189