Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document cancellation safety of the async APIs. #229

Open
alilleybrinker opened this issue Jan 29, 2025 · 0 comments
Open

Document cancellation safety of the async APIs. #229

alilleybrinker opened this issue Jan 29, 2025 · 0 comments

Comments

@alilleybrinker
Copy link
Member

We expose some async APIs but don't currently document the cancellation safety of them. This is critical for explaining what kind of state the APIs may leave things in if they are cancelled early, and what the caller should do, if anything, to handle that.

For example, the GitOid async APIs could leave the reader with partial reads. The caller should create a new reader (I think) to restart if cancelled early.

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

No branches or pull requests

1 participant