Skip to content

docs: clarify Pool::size and Pool::num_idle #4398

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
valentynkit wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: clarify Pool::size and Pool::num_idle #4398

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions sqlx-core/src/pool/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -531,12 +531,14 @@ impl<DB: Database> Pool<DB> {
self.0.close_event()
}

/// Returns the number of connections currently active. This includes idle connections.
/// Returns the total number of connections owned by the pool.
///
/// This includes idle connections and ones still being opened.
pub fn size(&self) -> u32 {
self.0.size()
}

/// Returns the number of connections active and idle (not in use).
/// Returns the number of idle connections (not checked out).
pub fn num_idle(&self) -> usize {
self.0.num_idle()
}
Expand Down
Loading