connection: more docs for rustls_connection_is_handshaking #430
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
Previously the rustls-ffi `rustls_connection_is_handshaking` fn only pointed at the upstream Rustls documentation. This commit adds a bit of the detail present there, customizing it for rustls-ffi (e.g. by ref'ing `rustls_connection_write_tls()`).
jsha
approved these changes
May 29, 2024
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.
Previously the rustls-ffi
rustls_connection_is_handshakingfn only pointed at the upstream Rustls documentation. This seems fine in general, but since there was confusion in #427 it felt fair to lift some details down into our own docs.This commit adds a bit of the detail present there, customizing it for rustls-ffi (e.g. by ref'ing
rustls_connection_write_tls()).Resolves #427