Skip to content

Commit

Permalink
Clean up docstring for CustomizeConnection::on_acquire()
Browse files Browse the repository at this point in the history
  • Loading branch information
djc committed Dec 27, 2020
1 parent 41e5ec1 commit 7150f7c
Showing 1 changed file with 3 additions and 7 deletions.
10 changes: 3 additions & 7 deletions bb8/src/api.rs
Original file line number Diff line number Diff line change
Expand Up @@ -273,13 +273,9 @@ pub trait CustomizeConnection<C: Send + 'static, E: 'static>:
/// Called with connections immediately after they are returned from
/// `ManageConnection::connect`.
///
/// The default implementation simply returns `Ok(())`.
///
/// # Errors
///
/// If this method returns an error, the connection will be discarded.
#[allow(unused_variables)]
async fn on_acquire(&self, connection: &mut C) -> Result<(), E> {
/// The default implementation simply returns `Ok(())`. If this method returns an
/// error, it will be forwarded to the configured error sink.
async fn on_acquire(&self, _connection: &mut C) -> Result<(), E> {
Ok(())
}
}
Expand Down

0 comments on commit 7150f7c

Please sign in to comment.