cursor: for now, add #[doc(hidden)] to from_connection and from_pool …

…as we look for ways to remove them
launchbadge · Mar 20, 2020 · f29c80c · f29c80c
1 parent ac59fe7
commit f29c80c
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 0 deletions.
diff --git a/sqlx-core/src/cursor.rs b/sqlx-core/src/cursor.rs
@@ -18,11 +18,13 @@ where
 {
     type Database: Database;
 
+    #[doc(hidden)]
     fn from_pool<E>(pool: &Pool<<Self::Database as Database>::Connection>, query: E) -> Self
     where
         Self: Sized,
         E: Execute<'q, Self::Database>;
 
+    #[doc(hidden)]
     fn from_connection<E>(
         connection: &'c mut <Self::Database as Database>::Connection,
         query: E,

diff --git a/sqlx-core/src/mysql/cursor.rs b/sqlx-core/src/mysql/cursor.rs
@@ -21,6 +21,7 @@ pub struct MySqlCursor<'c, 'q> {
 impl<'c, 'q> Cursor<'c, 'q> for MySqlCursor<'c, 'q> {
     type Database = MySql;
 
+    #[doc(hidden)]
     fn from_pool<E>(pool: &Pool<MySqlConnection>, query: E) -> Self
     where
         Self: Sized,
@@ -35,6 +36,7 @@ impl<'c, 'q> Cursor<'c, 'q> for MySqlCursor<'c, 'q> {
         }
     }
 
+    #[doc(hidden)]
     fn from_connection<E>(conn: &'c mut MySqlConnection, query: E) -> Self
     where
         Self: Sized,

diff --git a/sqlx-core/src/postgres/cursor.rs b/sqlx-core/src/postgres/cursor.rs
@@ -22,6 +22,7 @@ pub struct PgCursor<'c, 'q> {
 impl<'c, 'q> Cursor<'c, 'q> for PgCursor<'c, 'q> {
     type Database = Postgres;
 
+    #[doc(hidden)]
     fn from_pool<E>(pool: &Pool<PgConnection>, query: E) -> Self
     where
         Self: Sized,
@@ -35,6 +36,7 @@ impl<'c, 'q> Cursor<'c, 'q> for PgCursor<'c, 'q> {
         }
     }
 
+    #[doc(hidden)]
     fn from_connection<E>(conn: &'c mut PgConnection, query: E) -> Self
     where
         Self: Sized,

diff --git a/sqlx-core/src/sqlite/cursor.rs b/sqlx-core/src/sqlite/cursor.rs
@@ -17,6 +17,7 @@ pub struct SqliteCursor<'c, 'q> {
 impl<'c, 'q> Cursor<'c, 'q> for SqliteCursor<'c, 'q> {
     type Database = Sqlite;
 
+    #[doc(hidden)]
     fn from_pool<E>(pool: &Pool<SqliteConnection>, query: E) -> Self
     where
         Self: Sized,
@@ -32,6 +33,7 @@ impl<'c, 'q> Cursor<'c, 'q> for SqliteCursor<'c, 'q> {
         }
     }
 
+    #[doc(hidden)]
     fn from_connection<E>(conn: &'c mut SqliteConnection, query: E) -> Self
     where
         Self: Sized,