Skip to content

Commit 40a13cd

Browse files
committed
README: describre rustls-tls feature
1 parent ff7f896 commit 40a13cd

File tree

4 files changed

+23
-4
lines changed

4 files changed

+23
-4
lines changed

Cargo.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ optional = true
5555
[dependencies.rustls]
5656
version = "0.23"
5757
default-features = false
58+
features = ["std"]
5859
optional = true
5960

6061
[dependencies.rustls-pemfile]

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,16 @@ By default there are only two features enabled:
6565

6666
```toml
6767
[dependencies]
68-
mysql_async = { version = "*", default-features = false, features = ["native-tls-tls"] }
68+
mysql_async = { version = "*", default-features = false, features = ["minimal", "native-tls-tls"] }
69+
70+
* `rustls-tls` - enables rustls TLS backend with no provider. You should enable one
71+
of existing providers using `aws-lc-rs` or `ring` features:
72+
73+
**Example:**
74+
75+
```toml
76+
[dependencies]
77+
mysql_async = { version = "*", default-features = false, features = ["minimal-rust", "rustls-tls", "ring"] }
6978

7079
* `tracing` – enables instrumentation via `tracing` package.
7180

azure-pipelines.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,13 +43,13 @@ jobs:
4343
SSL=false COMPRESS=false cargo test
4444
SSL=true COMPRESS=false cargo test --features native-tls-tls
4545
SSL=false COMPRESS=true cargo test
46-
SSL=true COMPRESS=true cargo test --features rustls-tls
46+
SSL=true COMPRESS=true cargo test --features rustls-tls,ring
4747
4848
SSL=true COMPRESS=false cargo check --no-default-features --features default-rustls
4949
SSL=true COMPRESS=false cargo check --no-default-features --features default-rustls-ring
5050
SSL=true COMPRESS=false cargo check --no-default-features --features minimal
5151
SSL=true COMPRESS=false cargo check --no-default-features --features minimal-rust
52-
SSL=true COMPRESS=false cargo check --no-default-features --features tracing
52+
SSL=true COMPRESS=false cargo check --no-default-features --features minimal,tracing
5353
env:
5454
RUST_BACKTRACE: 1
5555
DATABASE_URL: mysql://root:[email protected]:3306/mysql

src/lib.rs

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,16 @@
6464
//!
6565
//! ```toml
6666
//! [dependencies]
67-
//! mysql_async = { version = "*", default-features = false, features = ["native-tls-tls"] }
67+
//! mysql_async = { version = "*", default-features = false, features = ["minimal", "native-tls-tls"] }
68+
//!
69+
//! * `rustls-tls` - enables rustls TLS backend with no provider. You should enable one
70+
//! of existing providers using `aws-lc-rs` or `ring` features:
71+
//!
72+
//! **Example:**
73+
//!
74+
//! ```toml
75+
//! [dependencies]
76+
//! mysql_async = { version = "*", default-features = false, features = ["minimal-rust", "rustls-tls", "ring"] }
6877
//!
6978
//! * `tracing` – enables instrumentation via `tracing` package.
7079
//!

0 commit comments

Comments
 (0)