Remove the Done trait, rename DbDone to DbOutcome

CHANGELOG.md

@@ -20,6 +20,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 -   [[#940]] Rename the `#[sqlx(rename)]` attribute used to specify the type name on the database
     side to `#[sqlx(type_name)]` [[@jplatte]].
 
+-   [[#976]] Rename the `DbDone` types to `DbOutcome`. [[@jplatte]]
+
+-   [[#976]] Remove the `Done` trait. The `.rows_affected()` method is now available as an inherent
+    method on `PgOutcome`, `MySqlOutcome` and so on. [[@jplatte]]
+
 ## 0.4.2 - 2020-12-19
 
 -   [[#908]] Fix `whoami` crash on FreeBSD platform [[@fundon]] [[@AldaronLau]]

examples/mysql/todos/src/main.rs

@@ -1,5 +1,4 @@
 use sqlx::mysql::MySqlPool;
-use sqlx::Done;
 use std::env;
 use structopt::StructOpt;
 

examples/postgres/mockable-todos/src/main.rs

@@ -1,7 +1,6 @@
 use async_trait::async_trait;
 use dotenv;
 use sqlx::postgres::PgPool;
-use sqlx::Done;
 use std::{env, io::Write, sync::Arc};
 use structopt::StructOpt;
 

examples/postgres/todos/src/main.rs

@@ -1,5 +1,4 @@
 use sqlx::postgres::PgPool;
-use sqlx::Done;
 use std::env;
 use structopt::StructOpt;
 

examples/sqlite/todos/src/main.rs

@@ -1,5 +1,4 @@
 use sqlx::sqlite::SqlitePool;
-use sqlx::Done;
 use std::env;
 use structopt::StructOpt;
 

sqlx-core/src/any/connection/executor.rs

@@ -1,5 +1,5 @@
 use crate::any::connection::AnyConnectionKind;
-use crate::any::{Any, AnyColumn, AnyConnection, AnyDone, AnyRow, AnyStatement, AnyTypeInfo};
+use crate::any::{Any, AnyColumn, AnyConnection, AnyOutcome, AnyRow, AnyStatement, AnyTypeInfo};
 use crate::database::Database;
 use crate::describe::Describe;
 use crate::error::Error;
@@ -15,7 +15,7 @@ impl<'c> Executor<'c> for &'c mut AnyConnection {
     fn fetch_many<'e, 'q: 'e, E: 'q>(
         self,
         mut query: E,
-    ) -> BoxStream<'e, Result<Either<AnyDone, AnyRow>, Error>>
+    ) -> BoxStream<'e, Result<Either<AnyOutcome, AnyRow>, Error>>
     where
         'c: 'e,
         E: Execute<'q, Self::Database>,

sqlx-core/src/any/database.rs

@@ -1,5 +1,5 @@
 use crate::any::{
-    AnyArgumentBuffer, AnyArguments, AnyColumn, AnyConnection, AnyDone, AnyRow, AnyStatement,
+    AnyArgumentBuffer, AnyArguments, AnyColumn, AnyConnection, AnyOutcome, AnyRow, AnyStatement,
     AnyTransactionManager, AnyTypeInfo, AnyValue, AnyValueRef,
 };
 use crate::database::{Database, HasArguments, HasStatement, HasStatementCache, HasValueRef};
@@ -16,7 +16,7 @@ impl Database for Any {
 
     type Row = AnyRow;
 
-    type Done = AnyDone;
+    type Outcome = AnyOutcome;
 
     type Column = AnyColumn;
 

sqlx-core/src/any/mod.rs

@@ -13,9 +13,9 @@ mod arguments;
 pub(crate) mod column;
 mod connection;
 mod database;
-mod done;
 mod kind;
 mod options;
+mod outcome;
 pub(crate) mod row;
 mod statement;
 mod transaction;
@@ -31,10 +31,10 @@ pub use column::{AnyColumn, AnyColumnIndex};
 pub use connection::AnyConnection;
 pub use database::Any;
 pub use decode::AnyDecode;
-pub use done::AnyDone;
 pub use encode::AnyEncode;
 pub use kind::AnyKind;
 pub use options::AnyConnectOptions;
+pub use outcome::AnyOutcome;
 pub use r#type::AnyType;
 pub use row::AnyRow;
 pub use statement::AnyStatement;

sqlx-core/src/any/done.rs → sqlx-core/src/any/outcome.rs

@@ -1,29 +1,23 @@
-use crate::any::Any;
-use crate::done::Done;
 use std::iter::{Extend, IntoIterator};
 
 #[derive(Debug, Default)]
-pub struct AnyDone {
+pub struct AnyOutcome {
     pub(crate) rows_affected: u64,
     pub(crate) last_insert_id: Option<i64>,
 }
 
-impl AnyDone {
-    pub fn last_insert_id(&self) -> Option<i64> {
-        self.last_insert_id
+impl AnyOutcome {
+    pub fn rows_affected(&self) -> u64 {
+        self.rows_affected
     }
-}
 
-impl Done for AnyDone {
-    type Database = Any;
-
-    fn rows_affected(&self) -> u64 {
-        self.rows_affected
+    pub fn last_insert_id(&self) -> Option<i64> {
+        self.last_insert_id
     }
 }
 
-impl Extend<AnyDone> for AnyDone {
-    fn extend<T: IntoIterator<Item = AnyDone>>(&mut self, iter: T) {
+impl Extend<AnyOutcome> for AnyOutcome {
+    fn extend<T: IntoIterator<Item = AnyOutcome>>(&mut self, iter: T) {
         for elem in iter {
             self.rows_affected += elem.rows_affected;
             self.last_insert_id = elem.last_insert_id;

sqlx-core/src/database.rs

@@ -58,7 +58,6 @@ use std::fmt::Debug;
 use crate::arguments::Arguments;
 use crate::column::Column;
 use crate::connection::Connection;
-use crate::done::Done;
 use crate::row::Row;
 use crate::statement::Statement;
 use crate::transaction::TransactionManager;
@@ -87,8 +86,8 @@ pub trait Database:
     /// The concrete `Row` implementation for this database.
     type Row: Row<Database = Self>;
 
-    /// The concrete `Done` implementation for this database.
-    type Done: Done<Database = Self>;
+    /// The concrete `Outcome` implementation for this database.
+    type Outcome: 'static + Sized + Send + Sync + Default + Extend<Self::Outcome>;
 
     /// The concrete `Column` implementation for this database.
     type Column: Column<Database = Self>;

sqlx-core/src/executor.rs

@@ -29,7 +29,7 @@ pub trait Executor<'c>: Send + Debug + Sized {
     fn execute<'e, 'q: 'e, E: 'q>(
         self,
         query: E,
-    ) -> BoxFuture<'e, Result<<Self::Database as Database>::Done, Error>>
+    ) -> BoxFuture<'e, Result<<Self::Database as Database>::Outcome, Error>>
     where
         'c: 'e,
         E: Execute<'q, Self::Database>,
@@ -41,7 +41,7 @@ pub trait Executor<'c>: Send + Debug + Sized {
     fn execute_many<'e, 'q: 'e, E: 'q>(
         self,
         query: E,
-    ) -> BoxStream<'e, Result<<Self::Database as Database>::Done, Error>>
+    ) -> BoxStream<'e, Result<<Self::Database as Database>::Outcome, Error>>
     where
         'c: 'e,
         E: Execute<'q, Self::Database>,
@@ -83,7 +83,7 @@ pub trait Executor<'c>: Send + Debug + Sized {
     ) -> BoxStream<
         'e,
         Result<
-            Either<<Self::Database as Database>::Done, <Self::Database as Database>::Row>,
+            Either<<Self::Database as Database>::Outcome, <Self::Database as Database>::Row>,
             Error,
         >,
     >

sqlx-core/src/lib.rs

@@ -58,7 +58,6 @@ pub mod statement;
 mod common;
 pub mod database;
 pub mod describe;
-pub mod done;
 pub mod executor;
 pub mod from_row;
 mod io;

sqlx-core/src/mssql/connection/executor.rs

@@ -10,7 +10,7 @@ use crate::mssql::protocol::packet::PacketType;
 use crate::mssql::protocol::rpc::{OptionFlags, Procedure, RpcRequest};
 use crate::mssql::protocol::sql_batch::SqlBatch;
 use crate::mssql::{
-    Mssql, MssqlArguments, MssqlConnection, MssqlDone, MssqlRow, MssqlStatement, MssqlTypeInfo,
+    Mssql, MssqlArguments, MssqlConnection, MssqlOutcome, MssqlRow, MssqlStatement, MssqlTypeInfo,
 };
 use either::Either;
 use futures_core::future::BoxFuture;
@@ -71,7 +71,7 @@ impl<'c> Executor<'c> for &'c mut MssqlConnection {
     fn fetch_many<'e, 'q: 'e, E: 'q>(
         self,
         mut query: E,
-    ) -> BoxStream<'e, Result<Either<MssqlDone, MssqlRow>, Error>>
+    ) -> BoxStream<'e, Result<Either<MssqlOutcome, MssqlRow>, Error>>
     where
         'c: 'e,
         E: Execute<'q, Self::Database>,
@@ -102,7 +102,7 @@ impl<'c> Executor<'c> for &'c mut MssqlConnection {
                         }
 
                         if done.status.contains(Status::DONE_COUNT) {
-                            r#yield!(Either::Left(MssqlDone {
+                            r#yield!(Either::Left(MssqlOutcome {
                                 rows_affected: done.affected_rows,
                             }));
                         }
@@ -114,7 +114,7 @@ impl<'c> Executor<'c> for &'c mut MssqlConnection {
 
                     Message::DoneInProc(done) => {
                         if done.status.contains(Status::DONE_COUNT) {
-                            r#yield!(Either::Left(MssqlDone {
+                            r#yield!(Either::Left(MssqlOutcome {
                                 rows_affected: done.affected_rows,
                             }));
                         }

sqlx-core/src/mssql/database.rs

@@ -1,6 +1,6 @@
 use crate::database::{Database, HasArguments, HasStatement, HasValueRef};
 use crate::mssql::{
-    MssqlArguments, MssqlColumn, MssqlConnection, MssqlDone, MssqlRow, MssqlStatement,
+    MssqlArguments, MssqlColumn, MssqlConnection, MssqlOutcome, MssqlRow, MssqlStatement,
     MssqlTransactionManager, MssqlTypeInfo, MssqlValue, MssqlValueRef,
 };
 
@@ -15,7 +15,7 @@ impl Database for Mssql {
 
     type Row = MssqlRow;
 
-    type Done = MssqlDone;
+    type Outcome = MssqlOutcome;
 
     type Column = MssqlColumn;
 

sqlx-core/src/mssql/mod.rs

@@ -4,10 +4,10 @@ mod arguments;
 mod column;
 mod connection;
 mod database;
-mod done;
 mod error;
 mod io;
 mod options;
+mod outcome;
 mod protocol;
 mod row;
 mod statement;
@@ -20,9 +20,9 @@ pub use arguments::MssqlArguments;
 pub use column::MssqlColumn;
 pub use connection::MssqlConnection;
 pub use database::Mssql;
-pub use done::MssqlDone;
 pub use error::MssqlDatabaseError;
 pub use options::MssqlConnectOptions;
+pub use outcome::MssqlOutcome;
 pub use row::MssqlRow;
 pub use statement::MssqlStatement;
 pub use transaction::MssqlTransactionManager;

sqlx-core/src/mssql/outcome.rs

@@ -0,0 +1,30 @@
+use std::iter::{Extend, IntoIterator};
+
+#[derive(Debug, Default)]
+pub struct MssqlOutcome {
+    pub(super) rows_affected: u64,
+}
+
+impl MssqlOutcome {
+    pub fn rows_affected(&self) -> u64 {
+        self.rows_affected
+    }
+}
+
+impl Extend<MssqlOutcome> for MssqlOutcome {
+    fn extend<T: IntoIterator<Item = MssqlOutcome>>(&mut self, iter: T) {
+        for elem in iter {
+            self.rows_affected += elem.rows_affected;
+        }
+    }
+}
+
+#[cfg(feature = "any")]
+impl From<MssqlOutcome> for crate::any::AnyOutcome {
+    fn from(done: MssqlOutcome) -> Self {
+        crate::any::AnyOutcome {
+            rows_affected: done.rows_affected,
+            last_insert_id: None,
+        }
+    }
+}

sqlx-core/src/mysql/connection/executor.rs

@@ -13,7 +13,7 @@ use crate::mysql::protocol::statement::{
 use crate::mysql::protocol::text::{ColumnDefinition, ColumnFlags, Query, TextRow};
 use crate::mysql::statement::{MySqlStatement, MySqlStatementMetadata};
 use crate::mysql::{
-    MySql, MySqlArguments, MySqlColumn, MySqlConnection, MySqlDone, MySqlRow, MySqlTypeInfo,
+    MySql, MySqlArguments, MySqlColumn, MySqlConnection, MySqlOutcome, MySqlRow, MySqlTypeInfo,
     MySqlValueFormat,
 };
 use crate::HashMap;
@@ -88,7 +88,7 @@ impl MySqlConnection {
         sql: &'q str,
         arguments: Option<MySqlArguments>,
         persistent: bool,
-    ) -> Result<impl Stream<Item = Result<Either<MySqlDone, MySqlRow>, Error>> + 'e, Error> {
+    ) -> Result<impl Stream<Item = Result<Either<MySqlOutcome, MySqlRow>, Error>> + 'e, Error> {
         let mut logger = QueryLogger::new(sql, self.log_settings.clone());
 
         self.stream.wait_until_ready().await?;
@@ -133,7 +133,7 @@ impl MySqlConnection {
                     // this indicates either a successful query with no rows at all or a failed query
                     let ok = packet.ok()?;
 
-                    let done = MySqlDone {
+                    let done = MySqlOutcome {
                         rows_affected: ok.affected_rows,
                         last_insert_id: ok.last_insert_id,
                     };
@@ -171,7 +171,7 @@ impl MySqlConnection {
                     if packet[0] == 0xfe && packet.len() < 9 {
                         let eof = packet.eof(self.stream.capabilities)?;
 
-                        r#yield!(Either::Left(MySqlDone {
+                        r#yield!(Either::Left(MySqlOutcome {
                             rows_affected: 0,
                             last_insert_id: 0,
                         }));
@@ -213,7 +213,7 @@ impl<'c> Executor<'c> for &'c mut MySqlConnection {
     fn fetch_many<'e, 'q: 'e, E: 'q>(
         self,
         mut query: E,
-    ) -> BoxStream<'e, Result<Either<MySqlDone, MySqlRow>, Error>>
+    ) -> BoxStream<'e, Result<Either<MySqlOutcome, MySqlRow>, Error>>
     where
         'c: 'e,
         E: Execute<'q, Self::Database>,

sqlx-core/src/mysql/database.rs

@@ -1,7 +1,7 @@
 use crate::database::{Database, HasArguments, HasStatement, HasStatementCache, HasValueRef};
 use crate::mysql::value::{MySqlValue, MySqlValueRef};
 use crate::mysql::{
-    MySqlArguments, MySqlColumn, MySqlConnection, MySqlDone, MySqlRow, MySqlStatement,
+    MySqlArguments, MySqlColumn, MySqlConnection, MySqlOutcome, MySqlRow, MySqlStatement,
     MySqlTransactionManager, MySqlTypeInfo,
 };
 
@@ -16,7 +16,7 @@ impl Database for MySql {
 
     type Row = MySqlRow;
 
-    type Done = MySqlDone;
+    type Outcome = MySqlOutcome;
 
     type Column = MySqlColumn;