Skip to content

docs: document rustls-no-provider crypto provider initialization - #3106

Open
SatvikMishra08 wants to merge 1 commit into
seanmonstar:masterfrom
SatvikMishra08:docs/2924-rustls-no-provider
Open

SatvikMishra08 wants to merge 1 commit into
seanmonstar:masterfrom
SatvikMishra08:docs/2924-rustls-no-provider

Conversation

@SatvikMishra08

Copy link
Copy Markdown

Summary

Using the rustls-no-provider feature panics at Client construction unless a rustls crypto provider is installed first. #3021 improved the panic message and added tls module docs; the README (and the crate feature list) still did not surface the requirement.

This adds:

  • A README subsection under Requirements with a minimal Cargo.toml + install_default example (matching the issue's Option 3)
  • A one-line note on the rustls-no-provider feature in src/lib.rs pointing at the tls module

Fixes #2924

The `rustls-no-provider` feature requires installing a rustls crypto
provider before building a Client; omitting that panics at construction.
Document the requirement with a minimal Cargo.toml + init example in the
README, and note it in the crate feature list (tls module docs already
cover this).

Fixes seanmonstar#2924
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

Successfully merging this pull request may close these issues.

Document rustls-no-provider initialization requirement

1 participant