Skip to content

Commit acbf793

Browse files
committed
Cargo.toml: document available features
1 parent a63d8de commit acbf793

File tree

2 files changed

+20
-1
lines changed

2 files changed

+20
-1
lines changed

scylla-cql/Cargo.toml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,19 @@ license = "MIT OR Apache-2.0"
1414
all-features = true
1515

1616
[features]
17+
# Enables support for CQL ser/de of Secrecy type from secrecy 0.8 crate.
1718
secrecy-08 = ["dep:secrecy-08"]
19+
# Enables support for CQL ser/de of time/date types from time 0.3 crate.
1820
time-03 = ["dep:time-03"]
21+
# Enables support for CQL ser/de of time/date types from chrono 0.4 crate.
1922
chrono-04 = []
23+
# Enables support for CQL ser/de of arbitrary length integer types from num-bigint 0.3 crate.
2024
num-bigint-03 = ["dep:num-bigint-03"]
25+
# Enables support for CQL ser/de of arbitrary length integer types from num-bigint 0.4 crate.
2126
num-bigint-04 = ["dep:num-bigint-04"]
27+
# Enables support for CQL ser/de of arbitrary precision decimal types from bigdecimal 0.4 crate.
2228
bigdecimal-04 = ["dep:bigdecimal-04"]
29+
# Enables support for CQL ser/de of all supported external types.
2330
full-serialization = [
2431
"chrono-04",
2532
"time-03",

scylla/Cargo.toml

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,21 +16,31 @@ rustdoc-args = ["--cfg", "docsrs"]
1616

1717
[features]
1818
default = []
19+
# Enables TLS support via OpenSSL 0.10.
1920
openssl-010 = ["dep:tokio-openssl", "dep:openssl"]
21+
# Enables TLS support via rustls 0.23.
2022
rustls-023 = ["dep:tokio-rustls", "dep:rustls"]
23+
# Enables features required to work with Scylla Serverless Cloud.
2124
unstable-cloud = [
2225
"scylla-cql/serde",
2326
"dep:serde_yaml",
2427
"dep:serde",
2528
"dep:url",
2629
"dep:base64",
2730
]
31+
# Enables support for CQL ser/de of Secrecy type from secrecy 0.8 crate.
2832
secrecy-08 = ["scylla-cql/secrecy-08"]
33+
# Enables support for CQL ser/de of time/date types from chrono 0.4 crate.
2934
chrono-04 = ["scylla-cql/chrono-04"]
35+
# Enables support for CQL ser/de of time/date types from time 0.3 crate.
3036
time-03 = ["scylla-cql/time-03"]
37+
# Enables support for CQL ser/de of arbitrary length integer types from num-bigint 0.3 crate.
3138
num-bigint-03 = ["scylla-cql/num-bigint-03"]
39+
# Enables support for CQL ser/de of arbitrary length integer types from num-bigint 0.4 crate.
3240
num-bigint-04 = ["scylla-cql/num-bigint-04"]
41+
# Enables support for CQL ser/de of arbitrary precision decimal types from bigdecimal 0.4 crate.
3342
bigdecimal-04 = ["scylla-cql/bigdecimal-04"]
43+
# Enables support for CQL ser/de of all supported external types.
3444
full-serialization = [
3545
"chrono-04",
3646
"time-03",
@@ -39,7 +49,9 @@ full-serialization = [
3949
"num-bigint-04",
4050
"bigdecimal-04",
4151
]
52+
# Enables collection of internal driver metrics.
4253
metrics = ["dep:histogram"]
54+
# Opts-in to various unstable testing features.
4355
unstable-testing = []
4456

4557
[dependencies]
@@ -56,7 +68,7 @@ tokio = { version = "1.40", features = [
5668
"macros",
5769
] }
5870
tracing = "0.1.36"
59-
# Appears in various places of our public API
71+
# Appears in various places of our public API.
6072
bytes = "1.0.1"
6173
# Used for representing tracing ids and host ids.
6274
uuid = { version = "1.0", features = ["v4"] }

0 commit comments

Comments
 (0)