Merge pull request #1260 from Lorak-mmk/review-doc-hidden

Address unnecessary doc(hidden)

Author: Lorak-mmk

Cargo.lock.msrv

@@ -20,7 +20,7 @@ and `DeserializeValue` macros documentation.
 ```rust
 # extern crate scylla;
 # async fn check_only_compiles() {
-use scylla::macros::{DeserializeValue, SerializeValue};
+use scylla::{DeserializeValue, SerializeValue};
 
 // Define a custom struct that matches the User Defined Type created earlier.
 // Fields don't have to be in the same order as they are in the database.
@@ -48,7 +48,7 @@ Now it can be sent and received just like any other CQL value:
 # use std::error::Error;
 # async fn check_only_compiles(session: &Session) -> Result<(), Box<dyn Error>> {
 use futures::TryStreamExt;
-use scylla::macros::{DeserializeValue, SerializeValue};
+use scylla::{DeserializeValue, SerializeValue};
 
 #[derive(Debug, DeserializeValue, SerializeValue)]
 struct MyType {

docs/source/data-types/udt.md

@@ -97,8 +97,8 @@ Field names don't need to match column names.
 # use scylla::client::session::Session;
 # use std::error::Error;
 # async fn check_only_compiles(session: &Session) -> Result<(), Box<dyn Error>> {
-use scylla::macros::DeserializeRow;
-use scylla::deserialize::DeserializeRow;
+use scylla::DeserializeRow;
+use scylla::deserialize::row::DeserializeRow;
 
 #[derive(DeserializeRow)]
 struct MyRow {
@@ -120,4 +120,4 @@ for row in result_rows.rows::<MyRow>()? {
 ```
 
 ### Other data types
-For parsing other data types see [Data Types](../data-types/data-types.md)
+For parsing other data types see [Data Types](../data-types/data-types.md)

docs/source/statements/result.md

@@ -1,7 +1,7 @@
 use anyhow::Result;
 use scylla::client::session::Session;
 use scylla::client::session_builder::SessionBuilder;
-use scylla::deserialize::DeserializeValue;
+use scylla::deserialize::value::DeserializeValue;
 use scylla::frame::response::result::ColumnType;
 use std::env;
 

examples/custom_deserialization.rs

@@ -2,8 +2,7 @@ use anyhow::Result;
 use futures::TryStreamExt as _;
 use scylla::client::session::Session;
 use scylla::client::session_builder::SessionBuilder;
-use scylla::macros::DeserializeValue;
-use scylla::SerializeValue;
+use scylla::{DeserializeValue, SerializeValue};
 use std::env;
 
 #[tokio::main]

examples/user-defined-type.rs

@@ -11,7 +11,7 @@ categories = ["database"]
 license = "MIT OR Apache-2.0"
 
 [dependencies]
-scylla-macros = { version = "0.7.0", path = "../scylla-macros" }
+scylla-macros = { version = "=0.7.0", path = "../scylla-macros" }
 byteorder = "1.3.4"
 bytes = "1.0.1"
 tokio = { version = "1.34", features = ["io-util", "time"] }

scylla-cql/Cargo.toml

@@ -217,9 +217,6 @@ pub mod value;
 
 pub use frame_slice::FrameSlice;
 
-pub use row::DeserializeRow;
-pub use value::DeserializeValue;
-
 use std::error::Error;
 use std::sync::Arc;
 
@@ -238,8 +235,9 @@ use thiserror::Error;
 ///   one of types with an impl built into the driver fails. It is also returned
 ///   from impls generated by the `DeserializeRow` macro.
 /// - [`value::BuiltinTypeCheckError`] is analogous to the above but is
-///   returned from [`DeserializeValue::type_check`] instead both in the case of
-///   builtin impls and impls generated by the `DeserializeValue` macro.
+///   returned from [`DeserializeValue::type_check`](value::DeserializeValue::type_check)
+///   instead both in the case of builtin impls and impls generated by the
+///   `DeserializeValue` macro.
 ///   It won't be returned by the `Session` directly, but it might be nested
 ///   in the [`row::BuiltinTypeCheckError`].
 #[derive(Debug, Clone, Error)]
@@ -269,8 +267,9 @@ impl TypeCheckError {
 ///   one of types with an impl built into the driver fails. It is also returned
 ///   from impls generated by the `DeserializeRow` macro.
 /// - [`value::BuiltinDeserializationError`] is analogous to the above but is
-///   returned from [`DeserializeValue::deserialize`] instead both in the case of
-///   builtin impls and impls generated by the `DeserializeValue` macro.
+///   returned from [`DeserializeValue::deserialize`](value::DeserializeValue::deserialize)
+///   instead both in the case of builtin impls and impls generated by the
+///   `DeserializeValue` macro.
 ///   It won't be returned by the `Session` directly, but it might be nested
 ///   in the [`row::BuiltinDeserializationError`].
 #[derive(Debug, Clone, Error)]
@@ -296,10 +295,11 @@ impl DeserializationError {
 // - ONLY in proper type_check()/deserialize() implementation,
 // - BEFORE an error is cloned (because otherwise the Arc::get_mut fails).
 macro_rules! make_error_replace_rust_name {
-    ($fn_name: ident, $outer_err: ty, $inner_err: ty) => {
+    ($privacy: vis, $fn_name: ident, $outer_err: ty, $inner_err: ty) => {
         // Not part of the public API; used in derive macros.
         #[doc(hidden)]
-        pub fn $fn_name<RustT>(mut err: $outer_err) -> $outer_err {
+        #[allow(clippy::needless_pub_self)]
+        $privacy fn $fn_name<RustT>(mut err: $outer_err) -> $outer_err {
             // Safety: the assumed usage of this function guarantees that the Arc has not yet been cloned.
             let arc_mut = std::sync::Arc::get_mut(&mut err.0).unwrap();
 

scylla-cql/src/deserialize/mod.rs

@@ -125,12 +125,14 @@ impl<'frame, 'metadata> DeserializeRow<'frame, 'metadata> for ColumnIterator<'fr
 }
 
 make_error_replace_rust_name!(
+    pub(self),
     _typck_error_replace_rust_name,
     TypeCheckError,
     BuiltinTypeCheckError
 );
 
 make_error_replace_rust_name!(
+    pub,
     deser_error_replace_rust_name,
     DeserializationError,
     BuiltinDeserializationError

scylla-cql/src/deserialize/row.rs

@@ -675,12 +675,14 @@ where
 // collections
 
 make_error_replace_rust_name!(
+    pub(crate),
     typck_error_replace_rust_name,
     TypeCheckError,
     BuiltinTypeCheckError
 );
 
 make_error_replace_rust_name!(
+    pub,
     deser_error_replace_rust_name,
     DeserializationError,
     BuiltinDeserializationError

scylla-cql/src/deserialize/value.rs

@@ -243,14 +243,6 @@ impl PagingStateResponse {
             Self::NoMorePages => ControlFlow::Break(()),
         }
     }
-
-    /// Swaps the paging state response with PagingStateResponse::NoMorePages.
-    ///
-    /// Only for use in driver's inner code, as an optimisation.
-    #[doc(hidden)]
-    pub fn take(&mut self) -> Self {
-        std::mem::replace(self, Self::NoMorePages)
-    }
 }
 
 /// The state of a paged query, i.e. where to resume fetching result rows