Skip to content

Commit c5a3722

Browse files
committed
scylla/lib: add missing re-exported modules docs
1 parent a34a87c commit c5a3722

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

scylla/src/lib.rs

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,9 @@ pub mod _macro_internal {
102102
pub use scylla_cql::{DeserializeRow, DeserializeValue, SerializeRow, SerializeValue};
103103

104104
pub mod value {
105+
//! Defines CQL values of various types and their representations,
106+
//! as well as conversion between them and other types.
107+
105108
// Every `pub` item is re-exported here, apart from `deser_cql_value`.
106109
pub use scylla_cql::value::{
107110
Counter, CqlDate, CqlDecimal, CqlDecimalBorrowed, CqlDuration, CqlTime, CqlTimestamp,
@@ -110,20 +113,30 @@ pub mod value {
110113
}
111114

112115
pub mod frame {
116+
//! Abstractions of the CQL wire protocol.
117+
113118
pub use scylla_cql::frame::{frame_errors, Authenticator, Compression};
114119
pub(crate) use scylla_cql::frame::{
115120
parse_response_body_extensions, protocol_features, read_response_frame, request,
116121
server_event_type, FrameParams, SerializedRequest,
117122
};
118123

119124
pub mod types {
125+
//! CQL binary protocol in-wire types.
126+
120127
pub use scylla_cql::frame::types::{Consistency, SerialConsistency};
121128
}
122129

123130
pub mod response {
131+
//! CQL responses sent by the server.
132+
124133
pub(crate) use scylla_cql::frame::response::*;
125134

126135
pub mod result {
136+
//! CQL protocol-level representation of a `RESULT` response.
137+
//!
138+
//! Contains lower-level types that are used to represent the result of a query.
139+
127140
#[cfg(cpp_rust_unstable)]
128141
pub use scylla_cql::frame::response::result::DeserializedMetadataAndRawRows;
129142

0 commit comments

Comments
 (0)