docs(cpp): warn that an async future must not outlive its client#867
Merged
Conversation
The std::future returned by an <endpoint>_async companion borrows the object it was called on. On the transient view from client.historical() the view is destroyed at the end of the statement, so storing the future and calling get() later reads a dangling object. Document the lifetime contract on every generated _async method: call on a named HistoricalClient or chain the result, never store the future from the temporary historical() view. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This file contains hidden or 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
2 participants
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.
The
std::futurefrom a C++<endpoint>_asynccompanion borrows the object it was called on (it capturesthisfor the deferredstd::asynctask). On the transient view returned byclient.historical(), that view is destroyed at the end of the statement, so storing the future and callingget()later reads a dangling object (UB under ASan). Adds a\warningto every generated_asyncmethod documenting the standard std::async lifetime contract: call on a namedHistoricalClientor chain the result.HistoricalClient(named, owning) was always safe.🤖 Generated with Claude Code