Skip to content

Commit 08a76f4

Browse files
jplattejplatte
committed
Rename DbDone to DbOutcome
1 parent a1d562f commit 08a76f4

30 files changed

+91
-89
lines changed

‎CHANGELOG.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
2020
- [[#940]] Rename the `#[sqlx(rename)]` attribute used to specify the type name on the database
2121
side to `#[sqlx(type_name)]` [[@jplatte]].
2222

23+
- [[#976]] Rename the `DbDone` types to `DbOutcome`. [[@jplatte]]
24+
2325
- [[#976]] Remove the `Done` trait. The `.rows_affected()` method is now available as an inherent
24-
method on `PgDone`, `MySqlDone` and so on.
26+
method on `PgOutcome`, `MySqlOutcome` and so on. [[@jplatte]]
2527

2628
## 0.4.2 - 2020-12-19
2729

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
use crate::any::connection::AnyConnectionKind;
2-
use crate::any::{Any, AnyColumn, AnyConnection, AnyDone, AnyRow, AnyStatement, AnyTypeInfo};
2+
use crate::any::{Any, AnyColumn, AnyConnection, AnyOutcome, AnyRow, AnyStatement, AnyTypeInfo};
33
use crate::database::Database;
44
use crate::describe::Describe;
55
use crate::error::Error;
@@ -15,7 +15,7 @@ impl<'c> Executor<'c> for &'c mut AnyConnection {
1515
fn fetch_many<'e, 'q: 'e, E: 'q>(
1616
self,
1717
mut query: E,
18-
) -> BoxStream<'e, Result<Either<AnyDone, AnyRow>, Error>>
18+
) -> BoxStream<'e, Result<Either<AnyOutcome, AnyRow>, Error>>
1919
where
2020
'c: 'e,
2121
E: Execute<'q, Self::Database>,

‎sqlx-core/src/any/database.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
use crate::any::{
2-
AnyArgumentBuffer, AnyArguments, AnyColumn, AnyConnection, AnyDone, AnyRow, AnyStatement,
2+
AnyArgumentBuffer, AnyArguments, AnyColumn, AnyConnection, AnyOutcome, AnyRow, AnyStatement,
33
AnyTransactionManager, AnyTypeInfo, AnyValue, AnyValueRef,
44
};
55
use crate::database::{Database, HasArguments, HasStatement, HasStatementCache, HasValueRef};
@@ -16,7 +16,7 @@ impl Database for Any {
1616

1717
type Row = AnyRow;
1818

19-
type Done = AnyDone;
19+
type Outcome = AnyOutcome;
2020

2121
type Column = AnyColumn;
2222

‎sqlx-core/src/any/mod.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ mod arguments;
1313
pub(crate) mod column;
1414
mod connection;
1515
mod database;
16-
mod done;
1716
mod kind;
1817
mod options;
18+
mod outcome;
1919
pub(crate) mod row;
2020
mod statement;
2121
mod transaction;
@@ -31,10 +31,10 @@ pub use column::{AnyColumn, AnyColumnIndex};
3131
pub use connection::AnyConnection;
3232
pub use database::Any;
3333
pub use decode::AnyDecode;
34-
pub use done::AnyDone;
3534
pub use encode::AnyEncode;
3635
pub use kind::AnyKind;
3736
pub use options::AnyConnectOptions;
37+
pub use outcome::AnyOutcome;
3838
pub use r#type::AnyType;
3939
pub use row::AnyRow;
4040
pub use statement::AnyStatement;

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

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
use std::iter::{Extend, IntoIterator};
22

33
#[derive(Debug, Default)]
4-
pub struct AnyDone {
4+
pub struct AnyOutcome {
55
pub(crate) rows_affected: u64,
66
pub(crate) last_insert_id: Option<i64>,
77
}
88

9-
impl AnyDone {
9+
impl AnyOutcome {
1010
pub fn rows_affected(&self) -> u64 {
1111
self.rows_affected
1212
}
@@ -16,8 +16,8 @@ impl AnyDone {
1616
}
1717
}
1818

19-
impl Extend<AnyDone> for AnyDone {
20-
fn extend<T: IntoIterator<Item = AnyDone>>(&mut self, iter: T) {
19+
impl Extend<AnyOutcome> for AnyOutcome {
20+
fn extend<T: IntoIterator<Item = AnyOutcome>>(&mut self, iter: T) {
2121
for elem in iter {
2222
self.rows_affected += elem.rows_affected;
2323
self.last_insert_id = elem.last_insert_id;

‎sqlx-core/src/database.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -86,8 +86,8 @@ pub trait Database:
8686
/// The concrete `Row` implementation for this database.
8787
type Row: Row<Database = Self>;
8888

89-
/// The concrete `Done` implementation for this database.
90-
type Done: 'static + Sized + Send + Sync + Default + Extend<Self::Done>;
89+
/// The concrete `Outcome` implementation for this database.
90+
type Outcome: 'static + Sized + Send + Sync + Default + Extend<Self::Outcome>;
9191

9292
/// The concrete `Column` implementation for this database.
9393
type Column: Column<Database = Self>;

‎sqlx-core/src/executor.rs

+3-3
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ pub trait Executor<'c>: Send + Debug + Sized {
2929
fn execute<'e, 'q: 'e, E: 'q>(
3030
self,
3131
query: E,
32-
) -> BoxFuture<'e, Result<<Self::Database as Database>::Done, Error>>
32+
) -> BoxFuture<'e, Result<<Self::Database as Database>::Outcome, Error>>
3333
where
3434
'c: 'e,
3535
E: Execute<'q, Self::Database>,
@@ -41,7 +41,7 @@ pub trait Executor<'c>: Send + Debug + Sized {
4141
fn execute_many<'e, 'q: 'e, E: 'q>(
4242
self,
4343
query: E,
44-
) -> BoxStream<'e, Result<<Self::Database as Database>::Done, Error>>
44+
) -> BoxStream<'e, Result<<Self::Database as Database>::Outcome, Error>>
4545
where
4646
'c: 'e,
4747
E: Execute<'q, Self::Database>,
@@ -83,7 +83,7 @@ pub trait Executor<'c>: Send + Debug + Sized {
8383
) -> BoxStream<
8484
'e,
8585
Result<
86-
Either<<Self::Database as Database>::Done, <Self::Database as Database>::Row>,
86+
Either<<Self::Database as Database>::Outcome, <Self::Database as Database>::Row>,
8787
Error,
8888
>,
8989
>

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

+4-4
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ use crate::mssql::protocol::packet::PacketType;
1010
use crate::mssql::protocol::rpc::{OptionFlags, Procedure, RpcRequest};
1111
use crate::mssql::protocol::sql_batch::SqlBatch;
1212
use crate::mssql::{
13-
Mssql, MssqlArguments, MssqlConnection, MssqlDone, MssqlRow, MssqlStatement, MssqlTypeInfo,
13+
Mssql, MssqlArguments, MssqlConnection, MssqlOutcome, MssqlRow, MssqlStatement, MssqlTypeInfo,
1414
};
1515
use either::Either;
1616
use futures_core::future::BoxFuture;
@@ -71,7 +71,7 @@ impl<'c> Executor<'c> for &'c mut MssqlConnection {
7171
fn fetch_many<'e, 'q: 'e, E: 'q>(
7272
self,
7373
mut query: E,
74-
) -> BoxStream<'e, Result<Either<MssqlDone, MssqlRow>, Error>>
74+
) -> BoxStream<'e, Result<Either<MssqlOutcome, MssqlRow>, Error>>
7575
where
7676
'c: 'e,
7777
E: Execute<'q, Self::Database>,
@@ -102,7 +102,7 @@ impl<'c> Executor<'c> for &'c mut MssqlConnection {
102102
}
103103

104104
if done.status.contains(Status::DONE_COUNT) {
105-
r#yield!(Either::Left(MssqlDone {
105+
r#yield!(Either::Left(MssqlOutcome {
106106
rows_affected: done.affected_rows,
107107
}));
108108
}
@@ -114,7 +114,7 @@ impl<'c> Executor<'c> for &'c mut MssqlConnection {
114114

115115
Message::DoneInProc(done) => {
116116
if done.status.contains(Status::DONE_COUNT) {
117-
r#yield!(Either::Left(MssqlDone {
117+
r#yield!(Either::Left(MssqlOutcome {
118118
rows_affected: done.affected_rows,
119119
}));
120120
}

‎sqlx-core/src/mssql/database.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
use crate::database::{Database, HasArguments, HasStatement, HasValueRef};
22
use crate::mssql::{
3-
MssqlArguments, MssqlColumn, MssqlConnection, MssqlDone, MssqlRow, MssqlStatement,
3+
MssqlArguments, MssqlColumn, MssqlConnection, MssqlOutcome, MssqlRow, MssqlStatement,
44
MssqlTransactionManager, MssqlTypeInfo, MssqlValue, MssqlValueRef,
55
};
66

@@ -15,7 +15,7 @@ impl Database for Mssql {
1515

1616
type Row = MssqlRow;
1717

18-
type Done = MssqlDone;
18+
type Outcome = MssqlOutcome;
1919

2020
type Column = MssqlColumn;
2121

‎sqlx-core/src/mssql/mod.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ mod arguments;
44
mod column;
55
mod connection;
66
mod database;
7-
mod done;
87
mod error;
98
mod io;
109
mod options;
10+
mod outcome;
1111
mod protocol;
1212
mod row;
1313
mod statement;
@@ -20,9 +20,9 @@ pub use arguments::MssqlArguments;
2020
pub use column::MssqlColumn;
2121
pub use connection::MssqlConnection;
2222
pub use database::Mssql;
23-
pub use done::MssqlDone;
2423
pub use error::MssqlDatabaseError;
2524
pub use options::MssqlConnectOptions;
25+
pub use outcome::MssqlOutcome;
2626
pub use row::MssqlRow;
2727
pub use statement::MssqlStatement;
2828
pub use transaction::MssqlTransactionManager;

‎sqlx-core/src/postgres/done.rs ‎sqlx-core/src/mssql/outcome.rs

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
11
use std::iter::{Extend, IntoIterator};
22

33
#[derive(Debug, Default)]
4-
pub struct PgDone {
4+
pub struct MssqlOutcome {
55
pub(super) rows_affected: u64,
66
}
77

8-
impl PgDone {
8+
impl MssqlOutcome {
99
pub fn rows_affected(&self) -> u64 {
1010
self.rows_affected
1111
}
1212
}
1313

14-
impl Extend<PgDone> for PgDone {
15-
fn extend<T: IntoIterator<Item = PgDone>>(&mut self, iter: T) {
14+
impl Extend<MssqlOutcome> for MssqlOutcome {
15+
fn extend<T: IntoIterator<Item = MssqlOutcome>>(&mut self, iter: T) {
1616
for elem in iter {
1717
self.rows_affected += elem.rows_affected;
1818
}
1919
}
2020
}
2121

2222
#[cfg(feature = "any")]
23-
impl From<PgDone> for crate::any::AnyDone {
24-
fn from(done: PgDone) -> Self {
25-
crate::any::AnyDone {
23+
impl From<MssqlOutcome> for crate::any::AnyOutcome {
24+
fn from(done: MssqlOutcome) -> Self {
25+
crate::any::AnyOutcome {
2626
rows_affected: done.rows_affected,
2727
last_insert_id: None,
2828
}

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

+5-5
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ use crate::mysql::protocol::statement::{
1313
use crate::mysql::protocol::text::{ColumnDefinition, ColumnFlags, Query, TextRow};
1414
use crate::mysql::statement::{MySqlStatement, MySqlStatementMetadata};
1515
use crate::mysql::{
16-
MySql, MySqlArguments, MySqlColumn, MySqlConnection, MySqlDone, MySqlRow, MySqlTypeInfo,
16+
MySql, MySqlArguments, MySqlColumn, MySqlConnection, MySqlOutcome, MySqlRow, MySqlTypeInfo,
1717
MySqlValueFormat,
1818
};
1919
use crate::HashMap;
@@ -88,7 +88,7 @@ impl MySqlConnection {
8888
sql: &'q str,
8989
arguments: Option<MySqlArguments>,
9090
persistent: bool,
91-
) -> Result<impl Stream<Item = Result<Either<MySqlDone, MySqlRow>, Error>> + 'e, Error> {
91+
) -> Result<impl Stream<Item = Result<Either<MySqlOutcome, MySqlRow>, Error>> + 'e, Error> {
9292
let mut logger = QueryLogger::new(sql, self.log_settings.clone());
9393

9494
self.stream.wait_until_ready().await?;
@@ -133,7 +133,7 @@ impl MySqlConnection {
133133
// this indicates either a successful query with no rows at all or a failed query
134134
let ok = packet.ok()?;
135135

136-
let done = MySqlDone {
136+
let done = MySqlOutcome {
137137
rows_affected: ok.affected_rows,
138138
last_insert_id: ok.last_insert_id,
139139
};
@@ -171,7 +171,7 @@ impl MySqlConnection {
171171
if packet[0] == 0xfe && packet.len() < 9 {
172172
let eof = packet.eof(self.stream.capabilities)?;
173173

174-
r#yield!(Either::Left(MySqlDone {
174+
r#yield!(Either::Left(MySqlOutcome {
175175
rows_affected: 0,
176176
last_insert_id: 0,
177177
}));
@@ -213,7 +213,7 @@ impl<'c> Executor<'c> for &'c mut MySqlConnection {
213213
fn fetch_many<'e, 'q: 'e, E: 'q>(
214214
self,
215215
mut query: E,
216-
) -> BoxStream<'e, Result<Either<MySqlDone, MySqlRow>, Error>>
216+
) -> BoxStream<'e, Result<Either<MySqlOutcome, MySqlRow>, Error>>
217217
where
218218
'c: 'e,
219219
E: Execute<'q, Self::Database>,

‎sqlx-core/src/mysql/database.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
use crate::database::{Database, HasArguments, HasStatement, HasStatementCache, HasValueRef};
22
use crate::mysql::value::{MySqlValue, MySqlValueRef};
33
use crate::mysql::{
4-
MySqlArguments, MySqlColumn, MySqlConnection, MySqlDone, MySqlRow, MySqlStatement,
4+
MySqlArguments, MySqlColumn, MySqlConnection, MySqlOutcome, MySqlRow, MySqlStatement,
55
MySqlTransactionManager, MySqlTypeInfo,
66
};
77

@@ -16,7 +16,7 @@ impl Database for MySql {
1616

1717
type Row = MySqlRow;
1818

19-
type Done = MySqlDone;
19+
type Outcome = MySqlOutcome;
2020

2121
type Column = MySqlColumn;
2222

‎sqlx-core/src/mysql/mod.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ mod collation;
55
mod column;
66
mod connection;
77
mod database;
8-
mod done;
98
mod error;
109
mod io;
1110
mod options;
11+
mod outcome;
1212
mod protocol;
1313
mod row;
1414
mod statement;
@@ -24,9 +24,9 @@ pub use arguments::MySqlArguments;
2424
pub use column::MySqlColumn;
2525
pub use connection::MySqlConnection;
2626
pub use database::MySql;
27-
pub use done::MySqlDone;
2827
pub use error::MySqlDatabaseError;
2928
pub use options::{MySqlConnectOptions, MySqlSslMode};
29+
pub use outcome::MySqlOutcome;
3030
pub use row::MySqlRow;
3131
pub use statement::MySqlStatement;
3232
pub use transaction::MySqlTransactionManager;

‎sqlx-core/src/mysql/done.rs ‎sqlx-core/src/mysql/outcome.rs

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
use std::iter::{Extend, IntoIterator};
22

33
#[derive(Debug, Default)]
4-
pub struct MySqlDone {
4+
pub struct MySqlOutcome {
55
pub(super) rows_affected: u64,
66
pub(super) last_insert_id: u64,
77
}
88

9-
impl MySqlDone {
9+
impl MySqlOutcome {
1010
pub fn last_insert_id(&self) -> u64 {
1111
self.last_insert_id
1212
}
@@ -16,8 +16,8 @@ impl MySqlDone {
1616
}
1717
}
1818

19-
impl Extend<MySqlDone> for MySqlDone {
20-
fn extend<T: IntoIterator<Item = MySqlDone>>(&mut self, iter: T) {
19+
impl Extend<MySqlOutcome> for MySqlOutcome {
20+
fn extend<T: IntoIterator<Item = MySqlOutcome>>(&mut self, iter: T) {
2121
for elem in iter {
2222
self.rows_affected += elem.rows_affected;
2323
self.last_insert_id = elem.last_insert_id;
@@ -26,9 +26,9 @@ impl Extend<MySqlDone> for MySqlDone {
2626
}
2727

2828
#[cfg(feature = "any")]
29-
impl From<MySqlDone> for crate::any::AnyDone {
30-
fn from(done: MySqlDone) -> Self {
31-
crate::any::AnyDone {
29+
impl From<MySqlOutcome> for crate::any::AnyOutcome {
30+
fn from(done: MySqlOutcome) -> Self {
31+
crate::any::AnyOutcome {
3232
rows_affected: done.rows_affected,
3333
last_insert_id: Some(done.last_insert_id as i64),
3434
}

‎sqlx-core/src/pool/executor.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ where
1818
fn fetch_many<'e, 'q: 'e, E: 'q>(
1919
self,
2020
query: E,
21-
) -> BoxStream<'e, Result<Either<DB::Done, DB::Row>, Error>>
21+
) -> BoxStream<'e, Result<Either<DB::Outcome, DB::Row>, Error>>
2222
where
2323
E: Execute<'q, Self::Database>,
2424
{
@@ -83,7 +83,7 @@ macro_rules! impl_executor_for_pool_connection {
8383
) -> futures_core::stream::BoxStream<
8484
'e,
8585
Result<
86-
either::Either<<$DB as crate::database::Database>::Done, $R>,
86+
either::Either<<$DB as crate::database::Database>::Outcome, $R>,
8787
crate::error::Error,
8888
>,
8989
>

0 commit comments

Comments
 (0)