docs: clarify freeing client/server builder directly #443
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
cpu
force-pushed
the
cpu-better-builder-free-docs
branch
from
c6ba94d
to
22da4e1
Compare
I looked at fixing this one but the simple fix (renaming the allow) is mutually exclusive with the non-nightly |
Here's one alternative to consider: #444 |
ctz
approved these changes
Jul 29, 2024
Previously the docs for the `rustls_client_config_builder` and `rustls_server_config_builder` structs seemed to imply the only safe way to dispose of a builder was to build it, and then free the resulting config. It's also possible (and clearer for most error-handling paths) to free the builder directly. This commit updates the relevant docs to make this alternative option clearer.
Small readability tweaks to the comments that were updated in the previous commit to add some whitespace. Also fixes some parameter names that were referenced in `rustls_client_config_builder_new_custom` with the incorrect name.
cpu
force-pushed
the
cpu-better-builder-free-docs
branch
from
22da4e1
to
b3563a0
Compare
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 docs for the
rustls_client_config_builderandrustls_server_config_builderstructs seemed to imply the only safe way to dispose of a builder was to build it, and then free the resulting config (e.g. this is a pattern curl uses for its rustls-ffi integration ). It's also possible (and clearer for most error-handling paths) to free the builder directly.This commit updates the relevant docs to make this alternative option clearer.